Get Custom Metrics

get https://a.klaviyo.com/api/custom-metrics

Get all custom metrics in an account.

Rate limits:
Burst: 3/s
Steady: 60/m

Scopes:
metrics:read

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://a.klaviyo.com/api/custom-metrics \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/vnd.api+json' \
5
     --header 'revision: 2025-04-15'


xxxxxxxxxx
101
}
1
{
2
  "data": [
3
    {
4
      "type": "custom-metric",
5
      "id": "925e385b52fb405715f3616c337cc65c",
6
      "attributes": {
7
        "name": "My custom metric",
8
        "created": "2025-04-15T00:00:00Z",
9
        "updated": "2025-04-15T00:00:00Z",
10
        "definition": {
11
          "aggregation_method": "value",
12
          "metric_groups": [
13
            {
14
              "metric_id": "AAAAAA",
15
              "metric_filters": [
16
                {
17
                  "property": "my_string_property",
18
                  "filter": {
19
                    "type": "string",
20
                    "operator": "starts-with",
21
                    "value": "some_substring"
22
                  }
23
                },
24
                {
25
                  "property": "my_numeric_property",

200Success

4XXClient Error

5XXServer Error