Query Event Data

get https://a.klaviyo.com/api/v1/metric/{metric_id}/export

Exports event data from Klaviyo, optionally filtering and segmenting on available event properties. Note that the only comparison operator currently supported is =. To ensure a correct response, enter parameters in the curl request as they are ordered below:

📘
For a comprehensive list of native Klaviyo metrics and their associated attributes, see next page

Path Params

metric_id

string

required

Defaults to METRIC_ID

Query Params

start_date

string

Beginning of timeframe to pull event data for. The default value is 1 month ago. Can also accept a 10-digit UNIX timestamp. When sending a start_date, you must also send an end_date

Ex: 1610524800 OR 2021-01-13

end_date

string

End of timeframe to pull event data for. The default is the current day, or 1 month from start_date, whichever is sooner. Can also accept a 10-digit UNIX timestamp. When sending an end_date, you must also send a start_date. Must be at most 31 days after start_date

Ex: 1612080000 OR 2021-01-31

unit

string

Defaults to day

Granularity to bucket data points into - one of day, week, or month. Defaults to day.

measurement

string

Defaults to count

Type of metric to fetch - one of unique, count, value, or sum. Defaults to count. For sum a property name to operate on must be supplied as a JSON-encoded list like ["sum","ItemCount"]

where

string

Optional, JSON-encoded list. Conditions to use to filter the set of events. A max of 1 condition can be given. where and by parameters cannot be specified at the same time.

ex: [["$attributed_flow","=","FLOW_ID"]]

string

The name of a property to segment the event data on. where and by parameters cannot be specified at the same time. Cannot be used alongside where parameter.

count

integer

1 to 1000

Defaults to 25

Maximum number of segments to return. Default = 25, MAX = 1000

Response

Language

Credentials

Query


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://a.klaviyo.com/api/v1/metric/METRIC_ID/export?unit=day&measurement=count&count=25&api_key=PRIVATE_API_KEY' \
3
     --header 'accept: application/json'


xxxxxxxxxx
40
}
1
{
2
  "metric": {
3
    "object": "metric",
4
    "id": "METRIC_ID",
5
    "name": "Placed Order",
6
    "integration": {
7
      "category": "eCommerce",
8
      "object": "integration",
9
      "id": "INTEGRATION_ID",
10
      "name": "Shopify"
11
    },
12
    "created": "2015-02-12 18:02:34",
13
    "updated": "2015-02-12 18:51:41"
14
  },
15
  "start_date": "2015-01-01 00:00:00",
16
  "end_date": "2015-01-31 00:00:00",
17
  "unit": "weekly",
18
  "measurement": "c",
19
  "by": "",
20
  "where": "",
21
  "results": [
22
    {
23
      "segment": "Everyone",
24
      "data": [
25
        {

📘For a comprehensive list of native Klaviyo metrics and their associated attributes, see next page

200A JSON object relecting the input request parameters as well as a results property that contains a list of dictionaries - one per segment of the result set. Within each of those dictionaries is the name of the segment as well as a data property that is a list of the data points for that segment.

📘
For a comprehensive list of native Klaviyo metrics and their associated attributes, see next page