{ "info": { "_postman_id": "15257b82-e299-4fe8-bc33-e31cd1cbf60d", "name": "Klaviyo Accounts Metrics API", "description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.\n\nContact Support:\n Name: Klaviyo Developer Experience Team\n Email: developers@klaviyo.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:00:51.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "lastUpdatedBy": "35240", "uid": "35240-15257b82-e299-4fe8-bc33-e31cd1cbf60d" }, "item": [ { "name": "api", "item": [ { "name": "metrics", "item": [ { "name": "{id}", "item": [ { "name": "flow-triggers", "item": [ { "name": "Get Flows Triggered by Metric", "id": "b6f143b6-191a-498a-bd9e-db4fda2fe61d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/flow-triggers?fields[flow]=status,archived", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "flow-triggers" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" } ], "variable": [ { "id": "c85cf26b-88bb-4eb9-a1f9-b445e75866d2", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Get all flows where the given metric is being used as the trigger.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`flows:read`\n`metrics:read`" }, "response": [ { "id": "f764a374-d902-4953-bb3c-f5cccee9a77c", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/flow-triggers?fields[flow]=status,archived", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "flow-triggers" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"status\": \"\",\n \"archived\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"trigger_type\": \"Low Inventory\"\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-actions\": {\n \"data\": [\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n },\n \"tags\": {\n \"data\": [\n {\n \"type\": \"tag\",\n \"id\": \"\"\n },\n {\n \"type\": \"tag\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"flow\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"status\": \"\",\n \"archived\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"trigger_type\": \"Price Drop\"\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-actions\": {\n \"data\": [\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n },\n \"tags\": {\n \"data\": [\n {\n \"type\": \"tag\",\n \"id\": \"\"\n },\n {\n \"type\": \"tag\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-f764a374-d902-4953-bb3c-f5cccee9a77c" }, { "id": "0d20bb94-9dee-41b4-a843-ea3289817cb8", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/flow-triggers?fields[flow]=status,archived", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "flow-triggers" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-0d20bb94-9dee-41b4-a843-ea3289817cb8" }, { "id": "1d197b8f-aa1b-452f-9a91-1e3407dd8dc9", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/flow-triggers?fields[flow]=status,archived", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "flow-triggers" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-1d197b8f-aa1b-452f-9a91-1e3407dd8dc9" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-b6f143b6-191a-498a-bd9e-db4fda2fe61d" } ], "id": "d34bb205-25f8-4d01-9f4f-b517f4064711", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-d34bb205-25f8-4d01-9f4f-b517f4064711" }, { "name": "relationships", "item": [ { "name": "flow-triggers", "item": [ { "name": "Get IDs for Flows Triggered by Metric", "id": "8263d53c-8de1-412b-940e-dcb13e653818", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/relationships/flow-triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "relationships", "flow-triggers" ], "variable": [ { "id": "a53f7cd2-d315-4f4e-830d-ca11179935f7", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Get the IDs of all flows where the given metric is being used as the trigger.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`flows:read`\n`metrics:read`" }, "response": [ { "id": "6a72ace6-479f-4cd5-8364-917baf02ee9b", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/relationships/flow-triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "relationships", "flow-triggers" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-6a72ace6-479f-4cd5-8364-917baf02ee9b" }, { "id": "e28cc1d5-87aa-44b2-b667-9812d5b34e2f", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/relationships/flow-triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "relationships", "flow-triggers" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-e28cc1d5-87aa-44b2-b667-9812d5b34e2f" }, { "id": "f1232f60-0b1e-47cc-8673-fb6ccc41d143", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/relationships/flow-triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "relationships", "flow-triggers" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-f1232f60-0b1e-47cc-8673-fb6ccc41d143" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-8263d53c-8de1-412b-940e-dcb13e653818" } ], "id": "0b776862-8d10-47bd-82b1-4418bcf84a4b", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-0b776862-8d10-47bd-82b1-4418bcf84a4b" }, { "name": "metric-properties", "item": [ { "name": "Get Property IDs for Metric", "id": "fb95c08d-1612-4670-b47b-925caad38125", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/relationships/metric-properties", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "relationships", "metric-properties" ], "variable": [ { "id": "b8564029-9fa0-40d9-93cf-54bb4a8ffca8", "key": "id", "value": "", "description": "(Required) The ID of the metric" } ] }, "description": "Get the IDs of metric properties for the given metric.

*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "3cebb1d4-001c-46ea-99ee-f50b8e67365a", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/relationships/metric-properties", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "relationships", "metric-properties" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"metric-property\",\n \"id\": \"\"\n },\n {\n \"type\": \"metric-property\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-3cebb1d4-001c-46ea-99ee-f50b8e67365a" }, { "id": "6daf25ef-24ec-439c-afe3-6e8a72ee9ca4", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/relationships/metric-properties", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "relationships", "metric-properties" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-6daf25ef-24ec-439c-afe3-6e8a72ee9ca4" }, { "id": "40433cb2-adaf-4be2-9ae9-8807d904a7aa", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/relationships/metric-properties", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "relationships", "metric-properties" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-40433cb2-adaf-4be2-9ae9-8807d904a7aa" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-fb95c08d-1612-4670-b47b-925caad38125" } ], "id": "71fda50d-ddf8-4d72-be41-da30c2b25139", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-71fda50d-ddf8-4d72-be41-da30c2b25139" } ], "id": "8959637b-a7e3-4890-8c42-a70def601097", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-8959637b-a7e3-4890-8c42-a70def601097" }, { "name": "metric-properties", "item": [ { "name": "Get Properties for Metric", "id": "13c6b767-5068-4f26-87b9-870df70683be", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/metric-properties?additional-fields[metric-property]=sample_values,sample_values&fields[metric-property]=label,inferred_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "metric-properties" ], "query": [ { "description": "Request additional fields not included by default in the response. Supported values: 'sample_values'", "key": "additional-fields[metric-property]", "value": "sample_values,sample_values" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric-property]", "value": "label,inferred_type" } ], "variable": [ { "id": "a4a15752-9fd0-448c-8b3e-066c1bf0afc1", "key": "id", "value": "", "description": "(Required) The ID of the metric" } ] }, "description": "Get the metric properties for the given metric ID.

*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "aef7df55-fb59-4d7f-b882-eeb0cf7b1819", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/metric-properties?additional-fields[metric-property]=sample_values,sample_values&fields[metric-property]=label,inferred_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "metric-properties" ], "query": [ { "description": "Request additional fields not included by default in the response. Supported values: 'sample_values'", "key": "additional-fields[metric-property]", "value": "sample_values,sample_values" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric-property]", "value": "label,inferred_type" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"metric-property\",\n \"id\": \"\",\n \"attributes\": {\n \"label\": \"\",\n \"property\": \"\",\n \"inferred_type\": \"\",\n \"sample_values\": [\n \"\",\n \"\"\n ]\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"metric-property\",\n \"id\": \"\",\n \"attributes\": {\n \"label\": \"\",\n \"property\": \"\",\n \"inferred_type\": \"\",\n \"sample_values\": [\n \"\",\n \"\"\n ]\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-aef7df55-fb59-4d7f-b882-eeb0cf7b1819" }, { "id": "239fd480-c7ea-4e59-a46d-3205384f3358", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/metric-properties?additional-fields[metric-property]=sample_values,sample_values&fields[metric-property]=label,inferred_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "metric-properties" ], "query": [ { "description": "Request additional fields not included by default in the response. Supported values: 'sample_values'", "key": "additional-fields[metric-property]", "value": "sample_values,sample_values" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric-property]", "value": "label,inferred_type" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-239fd480-c7ea-4e59-a46d-3205384f3358" }, { "id": "7c2924c7-e463-4985-9ff7-99041deaf3d4", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id/metric-properties?additional-fields[metric-property]=sample_values,sample_values&fields[metric-property]=label,inferred_type", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id", "metric-properties" ], "query": [ { "description": "Request additional fields not included by default in the response. Supported values: 'sample_values'", "key": "additional-fields[metric-property]", "value": "sample_values,sample_values" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric-property]", "value": "label,inferred_type" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-7c2924c7-e463-4985-9ff7-99041deaf3d4" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-13c6b767-5068-4f26-87b9-870df70683be" } ], "id": "e34935fa-3c24-4dab-bbdc-847710b06758", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-e34935fa-3c24-4dab-bbdc-847710b06758" }, { "name": "Get Metric", "id": "63c958b5-1ac5-4134-b9c0-0cfdb28f7ca0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id?fields[flow]=status,archived&fields[metric]=created,created&include=flow-triggers,flow-triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "flow-triggers,flow-triggers" } ], "variable": [ { "id": "9263b5ef-9cc7-4470-8b80-7cb9feec7e14", "key": "id", "value": "", "description": "(Required) Metric ID" } ] }, "description": "Get a metric with the given metric ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "e8b3e778-3dfa-4f14-b6b1-66d78a5c66d6", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id?fields[flow]=status,archived&fields[metric]=created,created&include=flow-triggers,flow-triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "flow-triggers,flow-triggers" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"type\": \"flow\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"status\": \"\",\n \"archived\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"trigger_type\": \"Metric\"\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-actions\": {\n \"data\": [\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n },\n \"tags\": {\n \"data\": [\n {\n \"type\": \"tag\",\n \"id\": \"\"\n },\n {\n \"type\": \"tag\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"flow\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"status\": \"\",\n \"archived\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"trigger_type\": \"Price Drop\"\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-actions\": {\n \"data\": [\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n },\n \"tags\": {\n \"data\": [\n {\n \"type\": \"tag\",\n \"id\": \"\"\n },\n {\n \"type\": \"tag\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-e8b3e778-3dfa-4f14-b6b1-66d78a5c66d6" }, { "id": "db301eac-2964-4fa9-b448-299461197a95", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id?fields[flow]=status,archived&fields[metric]=created,created&include=flow-triggers,flow-triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "flow-triggers,flow-triggers" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-db301eac-2964-4fa9-b448-299461197a95" }, { "id": "040394e5-eea6-4e92-98b4-5707a9df076c", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics/:id?fields[flow]=status,archived&fields[metric]=created,created&include=flow-triggers,flow-triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "flow-triggers,flow-triggers" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-040394e5-eea6-4e92-98b4-5707a9df076c" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-63c958b5-1ac5-4134-b9c0-0cfdb28f7ca0" } ], "id": "a0a78c80-f9f5-4863-804c-08245202d432", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-a0a78c80-f9f5-4863-804c-08245202d432" }, { "name": "Get Metrics", "id": "9876ed97-5090-49f2-8e1f-5d8e3c3dad59", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/metrics?fields[flow]=status,archived&fields[metric]=created,created&filter=&include=flow-triggers,flow-triggers&page[cursor]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`integration.name`: `equals`
`integration.category`: `equals`", "key": "filter", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "flow-triggers,flow-triggers" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" } ] }, "description": "Get all metrics in an account.\n\nRequests can be filtered by the following fields:\nintegration `name`, integration `category`\n\nReturns a maximum of 200 results per page.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "320c206a-1c00-4af7-b283-366556e709f4", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics?fields[flow]=status,archived&fields[metric]=created,created&filter=&include=flow-triggers,flow-triggers&page[cursor]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`integration.name`: `equals`
`integration.category`: `equals`", "key": "filter", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "flow-triggers,flow-triggers" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"included\": [\n {\n \"type\": \"flow\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"status\": \"\",\n \"archived\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"trigger_type\": \"Added to List\"\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-actions\": {\n \"data\": [\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n },\n \"tags\": {\n \"data\": [\n {\n \"type\": \"tag\",\n \"id\": \"\"\n },\n {\n \"type\": \"tag\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"flow\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"status\": \"\",\n \"archived\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"trigger_type\": \"Date Based\"\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-actions\": {\n \"data\": [\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow-action\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n },\n \"tags\": {\n \"data\": [\n {\n \"type\": \"tag\",\n \"id\": \"\"\n },\n {\n \"type\": \"tag\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-320c206a-1c00-4af7-b283-366556e709f4" }, { "id": "faef5296-fd59-4125-b64f-f0985eb9e639", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics?fields[flow]=status,archived&fields[metric]=created,created&filter=&include=flow-triggers,flow-triggers&page[cursor]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`integration.name`: `equals`
`integration.category`: `equals`", "key": "filter", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "flow-triggers,flow-triggers" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-faef5296-fd59-4125-b64f-f0985eb9e639" }, { "id": "52b4e884-5dd6-42b6-abc1-4c5017e8f0e6", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metrics?fields[flow]=status,archived&fields[metric]=created,created&filter=&include=flow-triggers,flow-triggers&page[cursor]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[flow]", "value": "status,archived" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`integration.name`: `equals`
`integration.category`: `equals`", "key": "filter", "value": "" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "flow-triggers,flow-triggers" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination", "key": "page[cursor]", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-52b4e884-5dd6-42b6-abc1-4c5017e8f0e6" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-9876ed97-5090-49f2-8e1f-5d8e3c3dad59" } ], "id": "ad25aae7-3698-48e5-ab02-3f8f1581c7b0", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-ad25aae7-3698-48e5-ab02-3f8f1581c7b0" }, { "name": "metric-properties", "item": [ { "name": "{id}", "item": [ { "name": "metric", "item": [ { "name": "Get Metric for Metric Property", "id": "55497ab6-e351-40a3-a938-36da0ced9ef4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id/metric?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id", "metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "id": "5d7ccc66-8061-4c3d-9a23-e4fe4c54b53e", "key": "id", "value": "", "description": "(Required) The ID of the metric property" } ] }, "description": "Get the metric for the given metric property ID.

*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "d7ea9865-9b24-4598-8306-4cdce09ad8ae", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id/metric?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id", "metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-d7ea9865-9b24-4598-8306-4cdce09ad8ae" }, { "id": "6b24e371-adef-4413-9a1b-de89ac19bfc9", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id/metric?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id", "metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-6b24e371-adef-4413-9a1b-de89ac19bfc9" }, { "id": "02e48fb0-cc57-46ea-8e53-3f29c030eba4", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id/metric?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id", "metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-02e48fb0-cc57-46ea-8e53-3f29c030eba4" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-55497ab6-e351-40a3-a938-36da0ced9ef4" } ], "id": "2463ec80-79d6-4e28-a6f4-f524669f529a", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-2463ec80-79d6-4e28-a6f4-f524669f529a" }, { "name": "relationships", "item": [ { "name": "metric", "item": [ { "name": "Get Metric ID for Metric Property", "id": "262a5c44-3b28-4520-8d23-b4422d64d484", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id/relationships/metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id", "relationships", "metric" ], "variable": [ { "id": "5c231ea6-baf5-4f6d-ad45-79c3037ea51c", "key": "id", "value": "", "description": "(Required) The ID of the metric property" } ] }, "description": "Get the ID of the metric for the given metric property.

*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "3e8a633e-9ec6-48aa-99ad-62fc55241d45", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id/relationships/metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id", "relationships", "metric" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-3e8a633e-9ec6-48aa-99ad-62fc55241d45" }, { "id": "5427f69b-dc3f-4462-a5f3-de969865c5be", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id/relationships/metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id", "relationships", "metric" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-5427f69b-dc3f-4462-a5f3-de969865c5be" }, { "id": "f4b53a4f-7cbc-4a27-909c-de3d0c93d440", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id/relationships/metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id", "relationships", "metric" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-f4b53a4f-7cbc-4a27-909c-de3d0c93d440" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-262a5c44-3b28-4520-8d23-b4422d64d484" } ], "id": "ff4549a8-e0b7-49dd-b97b-583feffb9a37", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-ff4549a8-e0b7-49dd-b97b-583feffb9a37" } ], "id": "0f620ff4-dab8-4d5f-abcd-33eef00bb641", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-0f620ff4-dab8-4d5f-abcd-33eef00bb641" }, { "name": "Get Metric Property", "id": "369b946b-ab02-4ae0-8003-70f0c7bcae1d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id?additional-fields[metric-property]=sample_values,sample_values&fields[metric-property]=label,inferred_type&fields[metric]=created,created&include=metric,metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id" ], "query": [ { "description": "Request additional fields not included by default in the response. Supported values: 'sample_values'", "key": "additional-fields[metric-property]", "value": "sample_values,sample_values" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric-property]", "value": "label,inferred_type" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metric,metric" } ], "variable": [ { "id": "dbafdf35-8077-4bae-80f6-0942fbaa6400", "key": "id", "value": "", "description": "(Required) The ID of the metric property" } ] }, "description": "Get a metric property with the given metric property ID.

*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "8d0a7e12-dfeb-4cb5-a10e-7cd45f5e4fb1", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id?additional-fields[metric-property]=sample_values,sample_values&fields[metric-property]=label,inferred_type&fields[metric]=created,created&include=metric,metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id" ], "query": [ { "description": "Request additional fields not included by default in the response. Supported values: 'sample_values'", "key": "additional-fields[metric-property]", "value": "sample_values,sample_values" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric-property]", "value": "label,inferred_type" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metric,metric" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"metric-property\",\n \"id\": \"\",\n \"attributes\": {\n \"label\": \"\",\n \"property\": \"\",\n \"inferred_type\": \"\",\n \"sample_values\": [\n \"\",\n \"\"\n ]\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-8d0a7e12-dfeb-4cb5-a10e-7cd45f5e4fb1" }, { "id": "e0227068-1889-440a-bdff-ced98724b78c", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id?additional-fields[metric-property]=sample_values,sample_values&fields[metric-property]=label,inferred_type&fields[metric]=created,created&include=metric,metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id" ], "query": [ { "description": "Request additional fields not included by default in the response. Supported values: 'sample_values'", "key": "additional-fields[metric-property]", "value": "sample_values,sample_values" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric-property]", "value": "label,inferred_type" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metric,metric" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-e0227068-1889-440a-bdff-ced98724b78c" }, { "id": "bd9e77f2-d350-481f-b441-05c277d72d3d", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/metric-properties/:id?additional-fields[metric-property]=sample_values,sample_values&fields[metric-property]=label,inferred_type&fields[metric]=created,created&include=metric,metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-properties", ":id" ], "query": [ { "description": "Request additional fields not included by default in the response. Supported values: 'sample_values'", "key": "additional-fields[metric-property]", "value": "sample_values,sample_values" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric-property]", "value": "label,inferred_type" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metric,metric" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-bd9e77f2-d350-481f-b441-05c277d72d3d" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-369b946b-ab02-4ae0-8003-70f0c7bcae1d" } ], "id": "98798394-6f00-46cc-9f10-a4536f215f1b", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-98798394-6f00-46cc-9f10-a4536f215f1b" } ], "id": "c8012de4-65cd-471a-8a71-15306c2c9f31", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-c8012de4-65cd-471a-8a71-15306c2c9f31" }, { "name": "custom-metrics", "item": [ { "name": "{id}", "item": [ { "name": "metrics", "item": [ { "name": "Get Metrics for Custom Metric", "id": "a9305d44-0cfe-4532-9788-b2208a4f6057", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id/metrics?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id", "metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "id": "04934f82-a3c6-4447-ac94-acdc3b96ef27", "key": "id", "value": "", "description": "(Required) The ID of the custom metric" } ] }, "description": "Get all metrics for the given custom metric ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "0d9980bd-2e84-445f-bf08-e095eff31ce1", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id/metrics?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id", "metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-0d9980bd-2e84-445f-bf08-e095eff31ce1" }, { "id": "35f1a22e-6a43-477e-b3cd-879b7e8957bc", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id/metrics?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id", "metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-35f1a22e-6a43-477e-b3cd-879b7e8957bc" }, { "id": "7a99630b-b1e6-4a54-9289-1d23e5527995", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id/metrics?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id", "metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-7a99630b-b1e6-4a54-9289-1d23e5527995" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-a9305d44-0cfe-4532-9788-b2208a4f6057" } ], "id": "7c592e13-270a-45b6-be7d-caeb6227c81d", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-7c592e13-270a-45b6-be7d-caeb6227c81d" }, { "name": "relationships", "item": [ { "name": "metrics", "item": [ { "name": "Get Metric IDs for Custom Metric", "id": "d5ba19c4-4786-4e93-9a94-40bf4706e0b4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id/relationships/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id", "relationships", "metrics" ], "variable": [ { "id": "2718a725-9f15-4167-aef0-ac489a1f816e", "key": "id", "value": "", "description": "(Required) The ID of the custom metric" } ] }, "description": "Get all metrics for the given custom metric ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "c33f8838-9772-4fff-96c0-7728f620b26a", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id/relationships/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id", "relationships", "metrics" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-c33f8838-9772-4fff-96c0-7728f620b26a" }, { "id": "39e6d87a-2ad9-48fc-b2f1-a6f4c81161af", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id/relationships/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id", "relationships", "metrics" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-39e6d87a-2ad9-48fc-b2f1-a6f4c81161af" }, { "id": "9be741e8-4280-40d0-a2a3-a999b7df75e9", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id/relationships/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id", "relationships", "metrics" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-9be741e8-4280-40d0-a2a3-a999b7df75e9" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-d5ba19c4-4786-4e93-9a94-40bf4706e0b4" } ], "id": "ca979192-ed24-4b0a-a247-87a3d5724d67", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-ca979192-ed24-4b0a-a247-87a3d5724d67" } ], "id": "bd39edd2-defd-4779-9805-9e34c00694a1", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-bd39edd2-defd-4779-9805-9e34c00694a1" }, { "name": "Get Custom Metric", "id": "be2e4fbc-c559-4049-b246-bf6ae1b74644", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id?fields[custom-metric]=definition.metric_groups,definition&fields[metric]=created,created&include=metrics,metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metrics,metrics" } ], "variable": [ { "id": "8b410392-891a-469f-8290-983b63340933", "key": "id", "value": "", "description": "(Required) The ID of the custom metric" } ] }, "description": "Get a custom metric with the given custom metric ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "f2580676-899a-4a06-b018-b16a3c224312", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id?fields[custom-metric]=definition.metric_groups,definition&fields[metric]=created,created&include=metrics,metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metrics,metrics" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"definition\": {\n \"aggregation_method\": \"count\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metrics\": {\n \"data\": [\n {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-f2580676-899a-4a06-b018-b16a3c224312" }, { "id": "5ba16386-040a-4e71-b5db-e3e9915d5684", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id?fields[custom-metric]=definition.metric_groups,definition&fields[metric]=created,created&include=metrics,metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metrics,metrics" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-5ba16386-040a-4e71-b5db-e3e9915d5684" }, { "id": "11586df5-0872-464f-ac3c-f2b4464e61bf", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id?fields[custom-metric]=definition.metric_groups,definition&fields[metric]=created,created&include=metrics,metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metrics,metrics" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-11586df5-0872-464f-ac3c-f2b4464e61bf" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-be2e4fbc-c559-4049-b246-bf6ae1b74644" }, { "name": "Update Custom Metric", "id": "7c6dffa4-85ca-48f3-9fe3-7213a1879797", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"definition\": {\n \"aggregation_method\": \"count\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "variable": [ { "id": "56c3d603-434e-49ac-9a07-ec907552aaf0", "key": "id", "value": "", "description": "(Required) The ID of the custom metric" } ] }, "description": "Update a custom metric with the given custom metric ID.

*Rate limits*:
Burst: `1/s`
Steady: `15/m`
Daily: `15/d`\n\n**Scopes:**\n`metrics:write`" }, "response": [ { "id": "be5ac439-faf7-489d-9dd7-a68f7a19022d", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"definition\": {\n \"aggregation_method\": \"count\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"definition\": {\n \"aggregation_method\": \"value\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metrics\": {\n \"data\": [\n {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-be5ac439-faf7-489d-9dd7-a68f7a19022d" }, { "id": "6bdbda03-389e-4ff5-9ec5-4467369c28cb", "name": "Client Error", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"definition\": {\n \"aggregation_method\": \"count\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-6bdbda03-389e-4ff5-9ec5-4467369c28cb" }, { "id": "16b84fc1-86fb-4b5d-8348-10e9fbefe16c", "name": "Server Error", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"definition\": {\n \"aggregation_method\": \"count\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-16b84fc1-86fb-4b5d-8348-10e9fbefe16c" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-7c6dffa4-85ca-48f3-9fe3-7213a1879797" }, { "name": "Delete Custom Metric", "id": "1baa401a-4e46-4e9f-9ace-34144ac3e00b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "variable": [ { "id": "9a96350f-1b2c-483b-8c6f-6a2c9c26ff16", "key": "id", "value": "", "description": "(Required) The ID of the custom metric" } ] }, "description": "Delete a custom metric with the given custom metric ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:write`" }, "response": [ { "id": "2cefda7a-53c2-4ef9-83c8-6fbdbd6bb67c", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-2cefda7a-53c2-4ef9-83c8-6fbdbd6bb67c" }, { "id": "bbe3a71a-36af-4072-8b2a-8f286857c423", "name": "Client Error", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-bbe3a71a-36af-4072-8b2a-8f286857c423" }, { "id": "e59b67b2-2477-47d7-a4a8-dc5f7a4689bf", "name": "Server Error", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-e59b67b2-2477-47d7-a4a8-dc5f7a4689bf" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-1baa401a-4e46-4e9f-9ace-34144ac3e00b" } ], "id": "27cbb847-ad17-4b30-b6cd-e69423438323", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-27cbb847-ad17-4b30-b6cd-e69423438323" }, { "name": "Get Custom Metrics", "id": "cf27fdbb-b9b1-4ad0-a876-f8d71a218910", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics?fields[custom-metric]=definition.metric_groups,definition&fields[metric]=created,created&include=metrics,metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metrics,metrics" } ] }, "description": "Get all custom metrics in an account.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "b63ce784-5e37-46a3-b50f-47eeb1b0686a", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics?fields[custom-metric]=definition.metric_groups,definition&fields[metric]=created,created&include=metrics,metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metrics,metrics" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"custom-metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"definition\": {\n \"aggregation_method\": \"count\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than-or-equal\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metrics\": {\n \"data\": [\n {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"custom-metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"definition\": {\n \"aggregation_method\": \"value\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metrics\": {\n \"data\": [\n {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"included\": [\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-b63ce784-5e37-46a3-b50f-47eeb1b0686a" }, { "id": "f1714f06-cfde-43c8-a6a7-b1520a24c7a2", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics?fields[custom-metric]=definition.metric_groups,definition&fields[metric]=created,created&include=metrics,metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metrics,metrics" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-f1714f06-cfde-43c8-a6a7-b1520a24c7a2" }, { "id": "9f0fd6ff-f773-4ebe-8f8a-91edb97b0e61", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/custom-metrics?fields[custom-metric]=definition.metric_groups,definition&fields[metric]=created,created&include=metrics,metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "metrics,metrics" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-9f0fd6ff-f773-4ebe-8f8a-91edb97b0e61" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-cf27fdbb-b9b1-4ad0-a876-f8d71a218910" }, { "name": "Create Custom Metric", "id": "8e65de56-7892-42d7-9d25-35f9f089cbea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"attributes\": {\n \"name\": \"\",\n \"definition\": {\n \"aggregation_method\": \"value\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"not-equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/custom-metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics" ] }, "description": "Create a new custom metric.\n\nCustom metric objects must include a `name` and `definition`.

*Rate limits*:
Burst: `1/s`
Steady: `15/m`
Daily: `15/d`\n\n**Scopes:**\n`metrics:write`" }, "response": [ { "id": "391ee2a9-d0bb-4460-8199-a796f9bfc0ff", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"attributes\": {\n \"name\": \"\",\n \"definition\": {\n \"aggregation_method\": \"value\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"not-equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/custom-metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"definition\": {\n \"aggregation_method\": \"value\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metrics\": {\n \"data\": [\n {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-391ee2a9-d0bb-4460-8199-a796f9bfc0ff" }, { "id": "a56adccf-afcb-4954-b5dc-54eb8726ef8e", "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"attributes\": {\n \"name\": \"\",\n \"definition\": {\n \"aggregation_method\": \"value\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"not-equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/custom-metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-a56adccf-afcb-4954-b5dc-54eb8726ef8e" }, { "id": "51aabaf1-2836-4bff-883e-c4ddee75ca44", "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"attributes\": {\n \"name\": \"\",\n \"definition\": {\n \"aggregation_method\": \"value\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"not-equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/custom-metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "custom-metrics" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-51aabaf1-2836-4bff-883e-c4ddee75ca44" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-8e65de56-7892-42d7-9d25-35f9f089cbea" } ], "id": "6d4303e8-d13f-46d0-9ee0-1cc9bc36f038", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-6d4303e8-d13f-46d0-9ee0-1cc9bc36f038" }, { "name": "mapped-metrics", "item": [ { "name": "{id}", "item": [ { "name": "metric", "item": [ { "name": "Get Metric for Mapped Metric", "id": "b3de1080-7fb2-40e1-963c-f7e335975742", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/metric?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "id": "133c352d-e9b0-4a31-a3e4-ce92417b88a6", "key": "id", "value": "started_checkout", "description": "(Required) The type of mapping." } ] }, "description": "Get the metric for the given mapped metric ID (if applicable).

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "f63c655c-8f4f-43b9-adbc-fd8fd5492925", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/metric?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-f63c655c-8f4f-43b9-adbc-fd8fd5492925" }, { "id": "361addd3-f764-481f-b73f-f1e0e7d74020", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/metric?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-361addd3-f764-481f-b73f-f1e0e7d74020" }, { "id": "a0d0320b-6702-443d-9a4d-2c734d93d617", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/metric?fields[metric]=created,created", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-a0d0320b-6702-443d-9a4d-2c734d93d617" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-b3de1080-7fb2-40e1-963c-f7e335975742" } ], "id": "4029ad21-4f45-4b95-ba18-159774966577", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-4029ad21-4f45-4b95-ba18-159774966577" }, { "name": "relationships", "item": [ { "name": "metric", "item": [ { "name": "Get Metric ID for Mapped Metric", "id": "e1c19bad-92ab-49e2-a537-dc5d37b28028", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/relationships/metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "relationships", "metric" ], "variable": [ { "id": "78c6e652-e7b1-44ca-8c03-02919278e218", "key": "id", "value": "started_checkout", "description": "(Required) The type of mapping." } ] }, "description": "Get the ID of the metric for the given mapped metric.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "0e9b708e-29e3-4630-90a1-7afad14e65cb", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/relationships/metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "relationships", "metric" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-0e9b708e-29e3-4630-90a1-7afad14e65cb" }, { "id": "ad40a9e9-f27c-431f-9a1c-98e4e3a8a5db", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/relationships/metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "relationships", "metric" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-ad40a9e9-f27c-431f-9a1c-98e4e3a8a5db" }, { "id": "0ff52725-fbac-4ef3-9b60-4aa570cadd88", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/relationships/metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "relationships", "metric" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-0ff52725-fbac-4ef3-9b60-4aa570cadd88" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-e1c19bad-92ab-49e2-a537-dc5d37b28028" } ], "id": "c01f723f-c957-42ca-a236-9a714c332dcf", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-c01f723f-c957-42ca-a236-9a714c332dcf" }, { "name": "custom-metric", "item": [ { "name": "Get Custom Metric ID for Mapped Metric", "id": "7226b239-32f8-408c-b21e-1f1f558a7785", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/relationships/custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "relationships", "custom-metric" ], "variable": [ { "id": "6d43e9e4-8932-4ef2-88fd-ccaa80ca2d96", "key": "id", "value": "started_checkout", "description": "(Required) The type of mapping." } ] }, "description": "Get the ID of the custom metric for the given mapped metric.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "418e78b1-8d42-4027-b541-44842b75d0bb", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/relationships/custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "relationships", "custom-metric" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-418e78b1-8d42-4027-b541-44842b75d0bb" }, { "id": "1f285887-fcf0-4f96-8a30-de4f0f7437a3", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/relationships/custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "relationships", "custom-metric" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-1f285887-fcf0-4f96-8a30-de4f0f7437a3" }, { "id": "212e12e5-57ba-4394-873d-ef3697bce84a", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/relationships/custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "relationships", "custom-metric" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-212e12e5-57ba-4394-873d-ef3697bce84a" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-7226b239-32f8-408c-b21e-1f1f558a7785" } ], "id": "040ffa42-3503-454b-a6e2-0597f162d70a", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-040ffa42-3503-454b-a6e2-0597f162d70a" } ], "id": "e2843663-d3d8-430d-95f1-8b744143b2b2", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-e2843663-d3d8-430d-95f1-8b744143b2b2" }, { "name": "custom-metric", "item": [ { "name": "Get Custom Metric for Mapped Metric", "id": "a22e968e-5ae2-4ca9-b0cc-c4adcc86e4f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/custom-metric?fields[custom-metric]=definition.metric_groups,definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "custom-metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" } ], "variable": [ { "id": "973067ca-7317-4888-97fe-6c87047ec51a", "key": "id", "value": "started_checkout", "description": "(Required) The type of mapping." } ] }, "description": "Get the custom metric for the given mapped metric ID (if applicable).

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "1546ef2a-c14d-4ac3-a9fc-6844ae7c2e6d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/custom-metric?fields[custom-metric]=definition.metric_groups,definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "custom-metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"definition\": {\n \"aggregation_method\": \"value\",\n \"metric_groups\": [\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than-or-equal\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"less-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"metric_filters\": [\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"equals\",\n \"value\": \"\"\n }\n },\n {\n \"property\": \"\",\n \"filter\": {\n \"type\": \"numeric\",\n \"operator\": \"greater-than\",\n \"value\": \"\"\n }\n }\n ],\n \"value_property\": \"\"\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metrics\": {\n \"data\": [\n {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-1546ef2a-c14d-4ac3-a9fc-6844ae7c2e6d" }, { "id": "2300d3b7-f225-464e-9a52-b30990b11c3b", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/custom-metric?fields[custom-metric]=definition.metric_groups,definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "custom-metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-2300d3b7-f225-464e-9a52-b30990b11c3b" }, { "id": "15d1cad6-cd11-41a1-817b-dfa981e2a5ea", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id/custom-metric?fields[custom-metric]=definition.metric_groups,definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id", "custom-metric" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-15d1cad6-cd11-41a1-817b-dfa981e2a5ea" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-a22e968e-5ae2-4ca9-b0cc-c4adcc86e4f6" } ], "id": "e28250e3-13b2-4550-96e8-7d80d93183da", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-e28250e3-13b2-4550-96e8-7d80d93183da" }, { "name": "Get Mapped Metric", "id": "b2c0f251-9f6f-4e7b-97bb-74489df2a8a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id?fields[custom-metric]=definition.metric_groups,definition&fields[mapped-metric]=updated,updated&fields[metric]=created,created&include=custom-metric,custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[mapped-metric]", "value": "updated,updated" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "custom-metric,custom-metric" } ], "variable": [ { "id": "7a7db802-b338-4a21-8a9b-86967afe5455", "key": "id", "value": "started_checkout", "description": "(Required) The type of mapping." } ] }, "description": "Get the mapped metric with the given ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "9594deff-1c65-4e0d-b7e2-7b3c80d12f97", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id?fields[custom-metric]=definition.metric_groups,definition&fields[mapped-metric]=updated,updated&fields[metric]=created,created&include=custom-metric,custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[mapped-metric]", "value": "updated,updated" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "custom-metric,custom-metric" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"mapped-metric\",\n \"id\": \"refunded_sales\",\n \"attributes\": {\n \"updated\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n },\n \"custom-metric\": {\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n \"included\": [\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-9594deff-1c65-4e0d-b7e2-7b3c80d12f97" }, { "id": "8e3dee3a-1b36-463a-8efa-b607ba034b1d", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id?fields[custom-metric]=definition.metric_groups,definition&fields[mapped-metric]=updated,updated&fields[metric]=created,created&include=custom-metric,custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[mapped-metric]", "value": "updated,updated" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "custom-metric,custom-metric" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-8e3dee3a-1b36-463a-8efa-b607ba034b1d" }, { "id": "b864ef1b-1450-4789-935e-4eec5b3eaf00", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id?fields[custom-metric]=definition.metric_groups,definition&fields[mapped-metric]=updated,updated&fields[metric]=created,created&include=custom-metric,custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[mapped-metric]", "value": "updated,updated" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "custom-metric,custom-metric" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-b864ef1b-1450-4789-935e-4eec5b3eaf00" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-b2c0f251-9f6f-4e7b-97bb-74489df2a8a4" }, { "name": "Update Mapped Metric", "id": "f22af3bc-13ed-40b2-873f-f52a9b1fde94", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"mapped-metric\",\n \"id\": \"cancelled_sales\",\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n },\n \"custom-metric\": {\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id" ], "variable": [ { "id": "c4790fa0-2cd9-4061-92dc-6475ea1da67b", "key": "id", "value": "started_checkout", "description": "(Required) The type of mapping." } ] }, "description": "Update the mapped metric with the given ID.

*Rate limits*:
Burst: `1/s`
Steady: `15/m`
Daily: `30/d`\n\n**Scopes:**\n`metrics:write`" }, "response": [ { "id": "a4137c4b-8311-4dfb-8db3-038e096210fc", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"mapped-metric\",\n \"id\": \"cancelled_sales\",\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n },\n \"custom-metric\": {\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"mapped-metric\",\n \"id\": \"cancelled_sales\",\n \"attributes\": {\n \"updated\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n },\n \"custom-metric\": {\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-a4137c4b-8311-4dfb-8db3-038e096210fc" }, { "id": "1ef11fc6-4a46-4f52-93b4-811af6436a40", "name": "Client Error", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"mapped-metric\",\n \"id\": \"cancelled_sales\",\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n },\n \"custom-metric\": {\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-1ef11fc6-4a46-4f52-93b4-811af6436a40" }, { "id": "da0ae327-ba07-477c-ade2-3c99eb9ba59d", "name": "Server Error", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"mapped-metric\",\n \"id\": \"cancelled_sales\",\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n }\n },\n \"custom-metric\": {\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/mapped-metrics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-da0ae327-ba07-477c-ade2-3c99eb9ba59d" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-f22af3bc-13ed-40b2-873f-f52a9b1fde94" } ], "id": "86db16ad-207a-4d8e-a5df-abdd4ff802bb", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-86db16ad-207a-4d8e-a5df-abdd4ff802bb" }, { "name": "Get Mapped Metrics", "id": "0144cd94-10a6-47b5-b9dc-e1c6acb8d530", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics?fields[custom-metric]=definition.metric_groups,definition&fields[mapped-metric]=updated,updated&fields[metric]=created,created&include=custom-metric,custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[mapped-metric]", "value": "updated,updated" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "custom-metric,custom-metric" } ] }, "description": "Get all mapped metrics in an account.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "44931d76-19bc-44d1-b7bf-c8a18eed2ce2", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics?fields[custom-metric]=definition.metric_groups,definition&fields[mapped-metric]=updated,updated&fields[metric]=created,created&include=custom-metric,custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[mapped-metric]", "value": "updated,updated" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "custom-metric,custom-metric" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"type\": \"mapped-metric\",\n \"id\": \"revenue\",\n \"attributes\": {\n \"updated\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n },\n \"custom-metric\": {\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"mapped-metric\",\n \"id\": \"ordered_product\",\n \"attributes\": {\n \"updated\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"metric\": {\n \"data\": {\n \"type\": \"metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n },\n \"custom-metric\": {\n \"data\": {\n \"type\": \"custom-metric\",\n \"id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"included\": [\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n },\n {\n \"type\": \"metric\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"created\": \"\",\n \"updated\": \"\",\n \"integration\": {}\n },\n \"links\": {\n \"self\": \"\"\n },\n \"relationships\": {\n \"flow-triggers\": {\n \"data\": [\n {\n \"type\": \"flow\",\n \"id\": \"\"\n },\n {\n \"type\": \"flow\",\n \"id\": \"\"\n }\n ],\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-44931d76-19bc-44d1-b7bf-c8a18eed2ce2" }, { "id": "948f92ec-7875-49b2-97ae-992f4ae5f9c5", "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics?fields[custom-metric]=definition.metric_groups,definition&fields[mapped-metric]=updated,updated&fields[metric]=created,created&include=custom-metric,custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[mapped-metric]", "value": "updated,updated" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "custom-metric,custom-metric" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-948f92ec-7875-49b2-97ae-992f4ae5f9c5" }, { "id": "2f1233ed-d83f-4aa0-bcf1-cdba033ca9d2", "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/mapped-metrics?fields[custom-metric]=definition.metric_groups,definition&fields[mapped-metric]=updated,updated&fields[metric]=created,created&include=custom-metric,custom-metric", "host": [ "{{baseUrl}}" ], "path": [ "api", "mapped-metrics" ], "query": [ { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[custom-metric]", "value": "definition.metric_groups,definition" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[mapped-metric]", "value": "updated,updated" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "key": "fields[metric]", "value": "created,created" }, { "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships", "key": "include", "value": "custom-metric,custom-metric" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-2f1233ed-d83f-4aa0-bcf1-cdba033ca9d2" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-0144cd94-10a6-47b5-b9dc-e1c6acb8d530" } ], "id": "c2ee8f3d-ab88-4ccf-be5e-f8c1d4e366f4", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-c2ee8f3d-ab88-4ccf-be5e-f8c1d4e366f4" }, { "name": "metric-aggregates", "item": [ { "name": "Query Metric Aggregates", "id": "89666a6e-4a33-4f63-8110-ef6b9c97d1c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"metric-aggregate\",\n \"attributes\": {\n \"metric_id\": \"\",\n \"measurements\": [\n \"unique\",\n \"count\"\n ],\n \"filter\": [\n \"\",\n \"\"\n ],\n \"page_cursor\": \"\",\n \"interval\": \"day\",\n \"page_size\": 500,\n \"by\": [\n \"$flow\",\n \"$attributed_channel\"\n ],\n \"return_fields\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"UTC\",\n \"sort\": \"-$attributed_message\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/metric-aggregates", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-aggregates" ] }, "description": "Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with [custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview), which are not supported at this time). Queries must be passed in the JSON body of your `POST` request.\n\nTo request campaign and flow performance data that matches the data shown in Klaviyo's UI, we recommend the [Reporting API](https://developers.klaviyo.com/en/reference/reporting_api_overview).\n\nResults can be filtered and grouped by time, event, or profile dimensions.\n\nTo learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint).\n\nFor a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`" }, "response": [ { "id": "70f447f7-3001-4cd4-9706-26c344b28f15", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"metric-aggregate\",\n \"attributes\": {\n \"metric_id\": \"\",\n \"measurements\": [\n \"unique\",\n \"count\"\n ],\n \"filter\": [\n \"\",\n \"\"\n ],\n \"page_cursor\": \"\",\n \"interval\": \"day\",\n \"page_size\": 500,\n \"by\": [\n \"$flow\",\n \"$attributed_channel\"\n ],\n \"return_fields\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"UTC\",\n \"sort\": \"-$attributed_message\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/metric-aggregates", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-aggregates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"type\": \"metric-aggregate\",\n \"id\": \"\",\n \"attributes\": {\n \"dates\": [\n \"\",\n \"\"\n ],\n \"data\": [\n {\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"measurements\": {}\n },\n {\n \"dimensions\": [\n \"\",\n \"\"\n ],\n \"measurements\": {}\n }\n ]\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-70f447f7-3001-4cd4-9706-26c344b28f15" }, { "id": "747df6a2-053e-4bed-9fb6-9de63fd0de99", "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"metric-aggregate\",\n \"attributes\": {\n \"metric_id\": \"\",\n \"measurements\": [\n \"unique\",\n \"count\"\n ],\n \"filter\": [\n \"\",\n \"\"\n ],\n \"page_cursor\": \"\",\n \"interval\": \"day\",\n \"page_size\": 500,\n \"by\": [\n \"$flow\",\n \"$attributed_channel\"\n ],\n \"return_fields\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"UTC\",\n \"sort\": \"-$attributed_message\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/metric-aggregates", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-aggregates" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-747df6a2-053e-4bed-9fb6-9de63fd0de99" }, { "id": "0be36281-24da-4f5b-ac80-17b08810e18f", "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])", "key": "revision", "value": "2026-04-15" }, { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"metric-aggregate\",\n \"attributes\": {\n \"metric_id\": \"\",\n \"measurements\": [\n \"unique\",\n \"count\"\n ],\n \"filter\": [\n \"\",\n \"\"\n ],\n \"page_cursor\": \"\",\n \"interval\": \"day\",\n \"page_size\": 500,\n \"by\": [\n \"$flow\",\n \"$attributed_channel\"\n ],\n \"return_fields\": [\n \"\",\n \"\"\n ],\n \"timezone\": \"UTC\",\n \"sort\": \"-$attributed_message\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/metric-aggregates", "host": [ "{{baseUrl}}" ], "path": [ "api", "metric-aggregates" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-0be36281-24da-4f5b-ac80-17b08810e18f" } ], "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-89666a6e-4a33-4f63-8110-ef6b9c97d1c8" } ], "id": "d15c0baf-5ea6-484c-8644-2a81af69e2e3", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-d15c0baf-5ea6-484c-8644-2a81af69e2e3" } ], "id": "efae436c-adbe-4038-b466-9c6b2fa999b5", "createdAt": "2026-07-28T02:00:52.000Z", "updatedAt": "2026-07-28T02:00:52.000Z", "uid": "35240-efae436c-adbe-4038-b466-9c6b2fa999b5" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://a.klaviyo.com" } ] }