v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Basics

Get Date Range

Returns the date range with available data for a website's prompts. Use this to determine the valid date range for other API queries.

get/api/v1/date-range

Query parameters

website_idstring uuid required

The ID of the website to retrieve the date range for

prompt_status'active' | 'paused'

Filter by prompt status. If omitted, includes all prompts (active and paused).

Response

Successful response with date range

min_datestring date-time nullable required

The earliest timestamp with available data (UTC)

max_datestring date-time nullable required

The latest timestamp with available data (UTC)

Example response

{
  "min_date": "2024-01-15T08:20:17.844Z",
  "max_date": "2024-12-01T14:30:45.123Z"
}