Skip to content

Metrics API

Counts, sums and unique people for a metric over time

POSThttps://email.growthdept.ai/api/metric-aggregates

The request body can be up to 5 MB.

Rate limits

Burst: 3/s

Steady: 60/m

Tier S. See rate limits for how requests are counted.

Scopes

metrics:read

Operation id

query_metric_aggregates The same operation as in Klaviyo's API. OpenAPI document

Query parameters

array of strings

Attributes of metric-aggregate resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      metric-aggregate
    • idstring

    • attributesobjectrequired

      attributes: 10 fields
      • metric_idstringrequired

      • page_cursorstringcan be null

      • measurementsarray of stringsrequired

      • intervalstring

      • page_sizeinteger

      • byarray of strings

      • return_fieldsarray of strings

      • filterarray of stringsrequired

      • timezonestringcan be null

      • sortstring

    • relationshipsobject

    • metaobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataobjectrequired

    data: 4 fields
    • typestringrequired

      metric-aggregate
    • idstringrequired

    • attributesobjectrequired

      attributes: 2 fields
      • datesarray of stringsrequired

      • dataarray of objectsrequired

        data: 2 fields
        • dimensionsarray of stringsrequired

        • measurementsobjectrequired

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject