Skip to content

Metrics API

Get a metric property

GEThttps://email.growthdept.ai/api/metric-properties/{id}

A property key seen on a metric's events, with its inferred type and, on request, sample values.

Ask for sample_values with additional-fields[metric-property]; they are left out unless you do.

Rate limits

Burst: 1/s

Steady: 15/m

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

Scopes

metrics:read

Operation id

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

Path parameters

stringrequired

Query parameters

array of strings

Attributes left out unless asked for.

Additional fields guide

Pick values to add them to the request:

array of strings

Attributes of metric-property 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:

array of strings

Related resources to side-load.

Includes guide

Pick values to add them to the request:

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: 5 fields
    • typestringrequired

      metric-property
    • attributesobjectrequired

      attributes: 4 fields
      • sample_valuesarray of objectscan be null

        One option: integer

        No fields.

        One option: number

        No fields.

        One option: string

        No fields.

        One option: boolean

        No fields.

      • labelstringrequired

      • propertystringrequired

      • inferred_typestringrequired

    • idstringrequired

    • relationshipsobject

      relationships: 1 field
      • metricobject

        metric: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            metric
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • includedarray of objects

    included: 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: 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