Skip to content

Metrics API

Create a custom metric

POSThttps://email.growthdept.ai/api/custom-metrics

Combines metrics, optionally filtered by event properties, into one metric that is counted or summed.

The request body can be up to 5 MB.

Rate limits

Burst: 1/s

Steady: 15/m

Daily: 15/day

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

Scopes

metrics:write

Operation id

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

Query parameters

array of strings

Attributes of custom-metric 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

      custom-metric
    • idstring

    • attributesobjectrequired

      attributes: 2 fields
      • namestringrequired

      • definitionobjectrequired

        definition: 2 fields
        • aggregation_methodstringrequired

          countvalue
        • metric_groupsarray of objectsrequired

          metric_groups: 3 fields
          • metric_idstringrequired

          • metric_filtersarray of objects

            metric_filters: 2 fields
            • propertystringrequired

            • filterobjectrequired

              filter: 3 fields
              • typestringrequired

                numericstringexistencebooleanlist
              • operatorstringrequired

              • valueobject

          • value_propertystring

    • 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

201Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      custom-metric
    • idstringrequired

    • attributesobjectrequired

      attributes: 4 fields
      • namestringrequired

      • createdstring (date-time)required

      • updatedstring (date-time)required

      • definitionobjectrequired

        definition: 2 fields
        • aggregation_methodstringrequired

          countvalue
        • metric_groupsarray of objectsrequired

          metric_groups: 3 fields
          • metric_idstringrequired

          • metric_filtersarray of objectscan be null

            metric_filters: 2 fields
            • propertystringrequired

            • filterone ofrequired

              One option: NumericOperatorNumericFilter
              • typestringrequired

                numeric
              • operatorstringrequired

                equalsgreater-thangreater-than-or-equalless-thanless-than-or-equalnot-equals
              • valueobjectrequired

              One option: StringInArrayFilter
              • operatorstringrequired

                in
              • valuearray of stringsrequired

              • typestringrequired

                string
              One option: ExistenceOperatorExistenceFilter
              • typestringrequired

                existence
              • operatorstringrequired

                is-setnot-set
              One option: BooleanFilter
              • typestringrequired

                boolean
              • operatorstringrequired

                equals
              • valuebooleanrequired

              One option: StringOperatorStringFilter
              • typestringrequired

                string
              • operatorstringrequired

                containsends-withequalsnot-containsnot-ends-withnot-equalsnot-starts-withnregexregexstarts-with
              • valuestringrequiredcan be null

              One option: ListContainsOperatorListContainsFilter
              • typestringrequired

                list
              • operatorstringrequired

                containsnot-contains
              • valueobjectrequiredcan be null

              One option: ListRegexOperatorListContainsFilter
              • typestringrequired

                list
              • operatorstringrequired

                contains-ends-withcontains-starts-withnot-contains-ends-withnot-contains-starts-with
              • valueobjectrequiredcan be null

              One option: ListSubstringFilter
              • typestringrequired

                list
              • operatorstringrequired

                contains-substringnot-contains-substring
              • valuestringrequiredcan be null

          • value_propertystringcan be null

    • relationshipsobject

      relationships: 1 field
      • metricsobject

        metrics: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            metric
          • 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