Get form periodic report

Get a time series of form performance statistics within a date range. The response returns one row per
time bucket, each carrying the same counters as the summary report: views (form displayed),
interactions (visitor engaged with the form), submits (form successfully submitted), and signups
(contacts gained). Use GET /forms/{formID}/report instead when only totals and a per-device breakdown are
needed; this endpoint does not return a device breakdown.

Granularity: when granularity is omitted it is derived from the length of the requested range —
hour for a single day, day for up to a month, month for up to two years, and year beyond that.
When it is provided it must be available for the range, otherwise the request is rejected with 400:
hour requires a single-day range, day a range of up to a month, week a range of up to three months,
month a range longer than a month and up to two years, and year a range longer than two years.

The period value of each row is formatted according to the granularity in effect, and buckets are
aligned to the brand's timezone.

Scopes:
forms.read

Rate Limiting:
This endpoint is rate limited to 400 requests per minute.

Path Params
string
required

Form ID (24 character hexadecimal)

Query Params
string
required

Start of the date range, inclusive (RFC3339, e.g. 2024-01-01T00:00:00Z)

string
required

End of the date range, inclusive (RFC3339, e.g. 2024-01-31T23:59:59Z)

string
enum

Time bucket granularity

Allowed:
Headers
string
required
Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json