Query Form Series

POST {{baseUrl}}/api/form-series-reports/

    > 🚧 This endpoint is in beta and subject to change.
    >
    > A beta revision header (2024-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.

Returns the requested form analytics series data.

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

Scopes: forms:read

Request Body

{"data"=>{"type"=>"form-series-report", "attributes"=>{"statistics"=>["submitted_form_step_uniques", "submits"], "timeframe"=>{"key"=>"last_month"}, "interval"=>"hourly", "group_by"=>["form_version_id", "form_id"], "filter"=>"<string>"}}}

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;data&quot;:{&quot;type&quot;:&quot;form-series-report&quot;,&quot;attributes&quot;:{&quot;results&quot;:[{&quot;groupings&quot;:{},&quot;statistics&quot;:{}},{&quot;groupings&quot;:{},&quot;statistics&quot;:{}}],&quot;date_times&quot;:[&quot;\u003cdateTime\u003e&quot;,&quot;\u003cdateTime\u003e&quot;]},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;}}}