{ "openapi": "3.0.2", "info": { "title": "Klaviyo API", "version": "2026-04-15", "description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.", "contact": { "name": "Klaviyo Developer Experience Team", "email": "developers@klaviyo.com", "url": "https://developers.klaviyo.com" }, "termsOfService": "https://www.klaviyo.com/legal/api-terms", "license": { "name": "License", "url": "https://www.klaviyo.com/legal" } }, "servers": [ { "url": "https://a.klaviyo.com", "description": "Production" } ], "security": [ { "Klaviyo-API-Key": [] } ], "paths": { "/api/metrics/{id}/metric-properties": { "get": { "operationId": "get_properties_for_metric", "summary": "Get Properties for 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`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_properties_for_metric.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the metric", "required": true, "schema": { "description": "The ID of the metric", "type": "string", "example": "925e38" } }, { "name": "additional-fields[metric-property]", "in": "query", "description": "Request additional fields not included by default in the response. Supported values: 'sample_values'", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "sample_values" ] } }, "explode": false }, { "name": "fields[metric-property]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "inferred_type", "label", "property", "sample_values" ] } }, "explode": false }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-04-15" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetMetricPropertyResponseCollection" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Metrics" ], "x-klaviyo-operation-aliases": [ "get_metric_metric_properties", "get_metric_properties" ], "x-klaviyo-pre-release": "None", "x-klaviyo-ratelimit": { "burst": "1/s", "steady": "15/m" }, "x-klaviyo-scopes": [ "metrics:read" ] } } }, "components": { "responses": { "ClientError": { "description": "Client Error", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "title", "detail" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "type": "string" }, "parameter": { "type": "string" } } } } } } }, "required": [ "errors" ] } } } }, "ServerError": { "description": "Server Error", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "title", "detail" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "type": "string" }, "parameter": { "type": "string" } } } } } } }, "required": [ "errors" ] } } } } }, "schemas": { "CollectionLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" }, "prev": { "type": "string", "format": "uri" }, "next": { "type": "string", "format": "uri" } }, "required": [ "self" ] }, "GetMetricPropertyResponseCollection": { "type": "object", "properties": { "data": { "type": "array", "items": { "allOf": [ { "properties": { "type": { "$ref": "#/components/schemas/MetricPropertyEnum" }, "attributes": { "properties": { "sample_values": { "type": "array", "items": { "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] }, "nullable": true } } } } }, { "$ref": "#/components/schemas/MetricPropertyResponseObjectResource" } ] } }, "links": { "$ref": "#/components/schemas/CollectionLinks" } }, "required": [ "data" ] }, "MetricEnum": { "type": "string", "enum": [ "metric" ] }, "MetricPropertyEnum": { "type": "string", "enum": [ "metric-property" ] }, "MetricPropertyResponseObjectResource": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/MetricPropertyEnum" }, "id": { "description": "The ID of the metric property", "type": "string", "example": "925e385b52fb405715f3616c337cc65c" }, "attributes": { "type": "object", "properties": { "label": { "description": "The label for this metric property", "type": "string", "example": "Categories" }, "property": { "description": "The property for this metric property", "type": "string", "example": "Categories" }, "inferred_type": { "description": "Inferred type for this metric property", "type": "string", "example": "List" } }, "required": [ "label", "property", "inferred_type" ] }, "relationships": { "type": "object", "properties": { "metric": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/MetricEnum" }, "id": { "description": "Related Metric", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } } } }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "ObjectLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" } }, "required": [ "self" ] }, "RelationshipLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" }, "related": { "type": "string", "format": "uri" } }, "required": [ "self", "related" ] } }, "securitySchemes": { "Klaviyo-API-Key": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Private key authentication for /api/ endpoints is performed by setting the `Authorization` header to `Klaviyo-API-Key your-private-api-key`
For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#authentication", "x-default": "Klaviyo-API-Key your-private-api-key" } } }, "tags": [ { "name": "Metrics", "description": "metrics" } ] }