Skip to content

Metrics API

List metrics

GEThttps://email.growthdept.ai/api/metrics

Metrics in the account with the integration each comes from.

Sort by id, ascending or descending (put - in front).

Rate limits

Burst: 10/s

Steady: 150/m

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

Scopes

metrics:read

Operation id

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

Query parameters

array of strings

Attributes of flow resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of metric resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

string

Filter expression.

Filtering guide

Fields and the operators each one takes:

  • integration.name: equals
  • integration.category: equals

string

From links.next or links.prev of the previous page.

Pagination guide

string

Default id.

Sorting guide

Headers

stringrequireddefault 2026-10-15

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

Revisions guide

Responses

200Success

Response body

object

  • dataarray of objectsrequired

    data: 5 fields
    • typestringrequired

      metric
    • idstringrequired

    • attributesobjectrequired

      attributes: 4 fields
      • namestringcan be null

      • createdstringcan be null

      • updatedstringcan be null

      • integrationobjectcan be null

    • relationshipsobject

      relationships: 1 field
      • flow-triggersobject

        flow-triggers: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 3 fields
    • selfstring (uri)required

    • prevstring (uri)

    • nextstring (uri)

  • metaobject

  • includedarray of objects

    included: 5 fields
    • typestringrequired

      flow
    • idstringrequired

    • attributesobjectrequired

      attributes: 6 fields
      • namestringcan be null

      • statusstringcan be null

      • archivedbooleancan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • trigger_typestringcan be null

        Added to ListDate BasedLow InventoryMetricPrice DropUnconfigured
    • relationshipsobject

      relationships: 2 fields
      • flow-actionsobject

        flow-actions: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow-action
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • tagsobject

        tags: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            tag
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

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