Query Form Values
POST {{baseUrl}}/api/form-values-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 values data.
Rate limits:
Burst: 1/s
Steady: 2/m
Daily: 225/d
Scopes:
forms:read
Request Body
{"data"=>{"type"=>"form-values-report", "attributes"=>{"statistics"=>["submit_rate", "viewed_form"], "timeframe"=>{"key"=>"yesterday"}, "group_by"=>["form_version_id", "form_version_id"], "filter"=>"<string>"}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"type":"form-values-report","attributes":{"results":[{"groupings":{},"statistics":{}},{"groupings":{},"statistics":{}}]},"links":{"self":"\u003curi\u003e"}}}