# Get Metric Property
Get a metric property with the given metric property ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`
**Scopes:**
`metrics:read`
# OpenAPI definition
```json
{
"openapi": "3.0.2",
"info": {
"title": "Metrics API",
"version": "2025-01-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"
}
],
"paths": {
"/api/metric-properties/{id}": {
"get": {
"operationId": "get_metric_property",
"summary": "Get 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`",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the metric property",
"required": true,
"schema": {
"description": "The ID of the metric property",
"type": "string",
"example": "925e385b52fb405715f3616c337cc65c"
}
},
{
"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/v2025-01-15/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"label",
"property",
"inferred_type",
"sample_values"
]
}
},
"explode": false
},
{
"name": "fields[metric]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"created",
"updated",
"integration"
]
}
},
"explode": false
},
{
"name": "include",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2025-01-15/reference/api-overview#relationships",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"metric"
]
}
},
"explode": false
},
{
"name": "revision",
"in": "header",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"required": true,
"schema": {
"type": "string",
"default": "2025-01-15"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricPropertyResponseCompoundDocument"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"metrics:read"
]
}
}
},
"components": {
"schemas": {
"MetricEnum": {
"type": "string",
"enum": [
"metric"
]
},
"MetricResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/MetricEnum"
},
"id": {
"description": "The Metric ID",
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"description": "The name of the metric",
"type": "string"
},
"created": {
"description": "Creation time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"type": "string"
},
"updated": {
"description": "Last updated time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"type": "string"
},
"integration": {
"description": "The integration associated with the event",
"type": "object"
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"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"
]
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"GetMetricPropertyResponseCompoundDocument": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/MetricPropertyResponseObjectResource"
},
{
"properties": {
"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"
}
}
}
}
}
}
},
{
"properties": {
"type": {
"$ref": "#/components/schemas/MetricPropertyEnum"
},
"attributes": {
"properties": {
"sample_values": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricResponseObjectResource"
}
}
},
"required": [
"data"
]
},
"RelationshipLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"related": {
"type": "string",
"format": "uri"
}
},
"required": [
"self",
"related"
]
},
"ObjectLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
}
},
"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"
]
}
}
}
}
},
"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/v2025-01-15/reference/api-overview#authentication",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"tags": [
{
"name": "Metrics"
}
],
"security": [
{
"Klaviyo-API-Key": []
}
],
"x-readme": {
"explorer-enabled": false,
"proxy-enabled": true,
"samples-enabled": true
},
"_id": {
"buffer": {
"0": 103,
"1": 226,
"2": 175,
"3": 88,
"4": 45,
"5": 92,
"6": 183,
"7": 0,
"8": 55,
"9": 12,
"10": 62,
"11": 84
}
}
}
```