POST /api/custom-metrics

Create a new custom metric.

Custom metric objects must include a name and definition.

Rate limits:
Burst: 1/s
Steady: 15/m
Daily: 15/d

Scopes: metrics:write

OpenAPI Spec

Servers

Request headers

Name Type Required Description
revision String Yes

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

Default value: "2026-04-15"

Query parameters

Name Type Required Description
fields[custom-metric][] Array No

For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.