Query Flow Values

post https://a.klaviyo.com/api/flow-values-reports/

Returns the requested flow analytics values data

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

Scopes:
flows:read

Responses

Language

Credentials

Header


xxxxxxxxxx
18
1
curl --request POST \
2
     --url https://a.klaviyo.com/api/flow-values-reports/ \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --header 'revision: 2024-07-15' \
7
     --data '
8
{
9
  "data": {
10
    "type": "flow-values-report",
11
    "attributes": {
12
      "timeframe": {
13
        "key": "last_12_months"
14
      }
15
    }
16
  }
17
}
18
'


xxxxxxxxxx
57
}
1
{
2
  "data": {
3
    "type": "flow-values-report",
4
    "attributes": {
5
      "results": [
6
        {
7
          "groupings": {
8
            "flow_id": "XVTP5Q",
9
            "send_channel": "email",
10
            "flow_message_id": "01GMRWDSA0ARTAKE1SFX8JGXAY"
11
          },
12
          "statistics": {
13
            "opens": 123,
14
            "open_rate": 0.8253
15
          }
16
        },
17
        {
18
          "groupings": {
19
            "flow_id": "XVTP5Q",
20
            "send_channel": "email",
21
            "flow_message_id": "01GJTHNWVG93F3KNX71SJ4FDBB"
22
          },
23
          "statistics": {
24
            "opens": 97,
25
            "open_rate": 0.7562

200Success

4XXClient Error

5XXServer Error