Create Custom Metric

post https://a.klaviyo.com/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

Responses

Language

Credentials

Header


xxxxxxxxxx
18
1
curl --request POST \
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 'content-type: application/vnd.api+json' \
6
     --header 'revision: 2025-04-15' \
7
     --data '
8
{
9
  "data": {
10
    "type": "custom-metric",
11
    "attributes": {
12
      "definition": {
13
        "aggregation_method": "count"
14
      }
15
    }
16
  }
17
}
18
'


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

201Success

4XXClient Error

5XXServer Error