HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Query Metric Aggregates

Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Queries must be passed in the JSON body of your POST request.

Results can be filtered and grouped by time, event, or profile dimensions.

To learn more about how to use this endpoint, check out our new Using the Query Metric Aggregates Endpoint guide.

Request body parameters (nested under attributes):

  • return_fields: request specific fields using sparse fieldsets
  • sort: sort results by a specified field, such as "-timestamp"
  • page_cursor: results can be paginated with cursor-based pagination
  • page_size: limit the number of returned results per page
  • by: optional attributes used to group by the aggregation function
    • When using by attributes, an empty dimensions response is expected when the counts for the events do not have the associated dimension requested by the set by attribute. For example, a query including "by": ["$flow"] will return an empty dimensions response for counts of metrics not associated with a $flow
  • measurement: the measurement key supports the following values:
    • "sum_value": perform a summation of the _Event Value_, optionally partitioned over any dimension provided in the by field
    • "count": counts the number of events associated to a metric, optionally partitioned over any dimension provided in the by field
    • "unique" counts the number of unique customers associated to a metric, optionally partitioned over any dimension provided in the by field
  • interval: aggregation interval, such as "hour","day","week", and "month"
  • metric_id: the metric ID used in the aggregation
  • filter: list of filters for specific fields, must include time range using ISO 8601 format ("YYYY-MM-DDTHH:MM:SS.mmmmmm")
    • The time range can be filtered by providing a greater-or-equal filter on the datetime field, such as "greater-or-equal(datetime,2021-07-01T00:00:00)" and a less-than filter on the same datetime field, such as "less-than(datetime,2022-07-01T00:00:00)"
    • The time range may span a maximum of one year. Time range dates may be set to a maximum of 5 years prior to the current date
    • Filter the list of supported aggregate dimensions using the common filter syntax, such as "equals(URL,\"https://www.klaviyo.com/\")"
  • timezone: the timezone used when processing the query. Case sensitive. This field is validated against a list of common timezones from the IANA Time Zone Database
    • While the payload accepts a timezone, the response datetimes returned will be in UTC.

For a comprehensive list of native Klaviyo metrics and their associated attributes for grouping and filtering, please refer to the metrics attributes guide.

Rate limits:
Burst: 3/s
Steady: 60/m

Scopes:
metrics:read

Body Params

Retrieve Metric Aggregations

object
required
string
required
object
required
string
required
Defaults to 0rG4eQ

The metric ID used in the aggregation.

string

Optional pagination cursor to iterate over large result sets

array of strings
required
Defaults to count

Measurement key, e.g. unique, sum_value, count

measurements*
string
Defaults to day

Aggregation interval, e.g. "hour", "day", "week", "month"

integer
Defaults to 500

Alter the maximum number of returned rows in a single page of aggregation results

array of strings
Defaults to $message

Optional attribute(s) used for partitioning by the aggregation function

by
array of strings

Provide fields to limit the returned data

return_fields
array of strings
required
Defaults to greater-or-equal(datetime,2022-12-01T00:00:00),less-than(datetime,2022-12-08T00:00:00

List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).
These filters follow a similar format to those in GET requests, the primary difference is that this endpoint asks for a list.
The time range can be filtered by providing a greater-or-equal and a less-than filter on the datetime field.

filter*
string
Defaults to UTC

The timezone used for processing the query, e.g. 'America/New_York'.
This field is validated against a list of common timezones from the IANA Time Zone Database.
While most are supported, a few notable exceptions are Factory, Europe/Kyiv and Pacific/Kanton. This field is case-sensitive.

string

Provide a sort key (e.g. -$message)

Headers
string
required
Defaults to 2024-02-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials