HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Query Form Series

Returns the requested form analytics series data.

Rate limits:
Burst: 1/s
Steady: 2/m
Daily: 225/d

Scopes:
forms:read

Body Params
object
required
string
required
object
required
array of strings
required

List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]

statistics*
required

The timeframe to query for data within. The max length a timeframe can be is 1 year

date-time
required
date-time
required
string
required

The interval used to aggregate data within the series request.
If hourly is used, the timeframe cannot be longer than 7 days.
If daily is used, the timeframe cannot be longer than 60 days.
If monthly is used, the timeframe cannot be longer than 52 weeks.

array of strings

List of attributes to group the data by.
Allowed group-bys are form_id, form_version_id.
If not passed in, the data will be grouped by form_id.
If a group by has prerequisites, they must be passed in together. The prerequisites for form_version_id is form_id

group_by
string

API filter string used to filter the query.
Allowed filters are form_id, form_version_id.
Allowed operators are equals, any.
Only one filter can be used per attribute, only AND can be used as a combination operator.
Max of 100 messages per ANY filter.

Headers
string
required
Defaults to 2025-01-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials