Query Campaign Values
POST {{baseUrl}}/api/campaign-values-reports/
Returns the requested campaign analytics values data
Rate limits:
Burst: 1/s
Steady: 2/m
Daily: 225/d
Scopes:
campaigns:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page_cursor | string | For more information please visit https://developers.klaviyo.com/en/v2024-05-15/reference/api-overview#pagination |
Request Body
{"data"=>{"type"=>"campaign-values-report", "attributes"=>{"statistics"=>["opens_unique", "conversion_value"], "timeframe"=>{"key"=>"this_month"}, "conversion_metric_id"=>"<string>", "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":"campaign-values-report","attributes":{"results":[{"groupings":{},"statistics":{}},{"groupings":{},"statistics":{}}]},"links":{"self":"\u003curi\u003e"},"relationships":{"campaigns":{"data":[{"type":"campaign","id":"\u003cstring\u003e"},{"type":"campaign","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}