Query Segment Values

post https://a.klaviyo.com/api/segment-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 for more information.

Returns the requested segment analytics values data.

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

Scopes:
segments:read

Responses

Language

Credentials

Header


xxxxxxxxxx
18
1
curl --request POST \
2
     --url https://a.klaviyo.com/api/segment-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.pre' \
7
     --data '
8
{
9
  "data": {
10
    "type": "segment-values-report",
11
    "attributes": {
12
      "timeframe": {
13
        "key": "last_12_months"
14
      }
15
    }
16
  }
17
}
18
'


xxxxxxxxxx
27
}
1
{
2
  "data": {
3
    "type": "segment-values-report",
4
    "attributes": {
5
      "results": [
6
        {
7
          "groupings": {
8
            "segment_id": "abc123"
9
          },
10
          "statistics": {
11
            "total_members": 120,
12
            "net_members_changed": 53
13
          }
14
        },
15
        {
16
          "groupings": {
17
            "segment_id": "def123"
18
          },
19
          "statistics": {
20
            "total_members": 250,
21
            "net_members_changed": 113
22
          }
23
        }
24
      ]
25
    }

200Success

4XXClient Error

5XXServer Error