Query Flow Series
POST {{baseUrl}}/api/flow-series-reports/
Returns the requested flow analytics series data
Rate limits:
Burst: 1/s
Steady: 2/m
Daily: 225/d
Scopes:
flows:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page_cursor | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination |
Request Body
{"data"=>{"type"=>"flow-series-report", "attributes"=>{"statistics"=>["unsubscribe_rate", "bounced_or_failed"], "timeframe"=>{"key"=>"this_month"}, "interval"=>"hourly", "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":"flow-series-report","attributes":{"results":[{"groupings":{},"statistics":{}},{"groupings":{},"statistics":{}}],"date_times":["\u003cdateTime\u003e","\u003cdateTime\u003e"]},"links":{"self":"\u003curi\u003e"},"relationships":{"flows":{"data":[{"type":"flow","id":"\u003cstring\u003e"},{"type":"flow","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"flow-messages":{"data":[{"type":"flow-message","id":"\u003cstring\u003e"},{"type":"flow-message","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}