Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Klaviyo Metrics API is one of 23 APIs that Klaviyo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, an API reference, authentication docs, and rate-limit docs.

This API exposes 24 operations across 20 paths, and defines 58 schemas. It is described by OpenAPI 3.0.2, at version 2026-04-15.

Requests are made against a single base URL, https://a.klaviyo.com.

24 operations 20 paths 58 schemas 1 DELETE19 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
2026-04-15
Base URL
https://a.klaviyo.com
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Klaviyo Metrics API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Klaviyo-API-Key). By default, every request must be authenticated.

  • Klaviyo-API-Key — Private key authentication for /api/ endpoints is performed by setting the Authorization header to Klaviyo-API-Key your-private-api-key For more information pl…

Paths & Operations 24

Across 20 paths, the API surfaces 24 operations — 1 DELETE, 19 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Metrics 24

metrics

GET
/api/metrics
Get Metrics
get_metrics 6 params → 2004XX5XX
GET
/api/metrics/{id}
Get Metric
get_metric 5 params → 2004XX5XX
GET
/api/metric-properties/{id}
Get Metric Property
get_metric_property 6 params → 2004XX5XX
GET
/api/custom-metrics
Get Custom Metrics
get_custom_metrics 4 params → 2004XX5XX
POST
/api/custom-metrics
Create Custom Metric
create_custom_metric 1 param body → 2014XX5XX
GET
/api/custom-metrics/{id}
Get Custom Metric
get_custom_metric 5 params → 2004XX5XX
PATCH
/api/custom-metrics/{id}
Update Custom Metric
update_custom_metric 2 params body → 2004XX5XX
DELETE
/api/custom-metrics/{id}
Delete Custom Metric
delete_custom_metric 2 params → 2044XX5XX
GET
/api/mapped-metrics
Get Mapped Metrics
get_mapped_metrics 5 params → 2004XX5XX
GET
/api/mapped-metrics/{id}
Get Mapped Metric
get_mapped_metric 6 params → 2004XX5XX
PATCH
/api/mapped-metrics/{id}
Update Mapped Metric
update_mapped_metric 2 params body → 2004XX5XX
POST
/api/metric-aggregates
Query Metric Aggregates
query_metric_aggregates 1 param body → 2004XX5XX
GET
/api/metrics/{id}/flow-triggers
Get Flows Triggered by Metric
get_flows_triggered_by_metric 3 params → 2004XX5XX
GET
/api/metrics/{id}/relationships/flow-triggers
Get IDs for Flows Triggered by Metric
get_ids_for_flows_triggered_by_metric 2 params → 2004XX5XX
GET
/api/metrics/{id}/metric-properties
Get Properties for Metric
get_properties_for_metric 4 params → 2004XX5XX
GET
/api/metrics/{id}/relationships/metric-properties
Get Property IDs for Metric
get_property_ids_for_metric 2 params → 2004XX5XX
GET
/api/metric-properties/{id}/metric
Get Metric for Metric Property
get_metric_for_metric_property 3 params → 2004XX5XX
GET
/api/metric-properties/{id}/relationships/metric
Get Metric ID for Metric Property
get_metric_id_for_metric_property 2 params → 2004XX5XX
GET
/api/custom-metrics/{id}/metrics
Get Metrics for Custom Metric
get_metrics_for_custom_metric 3 params → 2004XX5XX
GET
/api/custom-metrics/{id}/relationships/metrics
Get Metric IDs for Custom Metric
get_metric_ids_for_custom_metric 2 params → 2004XX5XX
GET
/api/mapped-metrics/{id}/metric
Get Metric for Mapped Metric
get_metric_for_mapped_metric 3 params → 2004XX5XX
GET
/api/mapped-metrics/{id}/relationships/metric
Get Metric ID for Mapped Metric
get_metric_id_for_mapped_metric 2 params → 2004XX5XX
GET
/api/mapped-metrics/{id}/custom-metric
Get Custom Metric for Mapped Metric
get_custom_metric_for_mapped_metric 3 params → 2004XX5XX
GET
/api/mapped-metrics/{id}/relationships/custom-metric
Get Custom Metric ID for Mapped Metric
get_custom_metric_id_for_mapped_metric 2 params → 2004XX5XX

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are MetricResponseObjectResource (5 properties), MetricPropertyResponseObjectResource (5 properties), CustomMetricResponseObjectResource (5 properties), MappedMetricResponseObjectResource (5 properties). Each schema is shown below with its type and property counts.

GetCustomMetricResponseCollectionCompoundDocument
object
3 properties 1 required
GetMetricResponse
object
2 properties 1 required
CustomMetricDefinition
object
2 properties 2 required
FlowResponseObjectResource
object
5 properties 4 required
MetricPropertyEnum
string
GetMappedMetricResponseCompoundDocument
object
3 properties 1 required
ExistenceOperatorExistenceFilter
object
2 properties 2 required
MappedMetricEnum
string
ListContainsOperatorListContainsFilter
object
3 properties 3 required
GetCustomMetricResponse
object
2 properties 1 required
GetFlowResponseCollection
object
2 properties 1 required
GetMappedMetricResponseCollectionCompoundDocument
object
3 properties 1 required
CustomMetricPartialUpdateQuery
object
1 property 1 required
GetMetricPropertyResponseCompoundDocument
object
3 properties 1 required
PatchMappedMetricResponse
object
2 properties 1 required
MetricAggregateQueryResourceObject
object
2 properties 2 required
StringOperatorStringFilter
object
3 properties 3 required
CustomMetricGroup
object
3 properties 1 required
PatchCustomMetricResponse
object
2 properties 1 required
GetMetricFlowTriggersRelationshipsResponseCollection
object
2 properties 1 required
CustomMetricEnum
string
ListRegexOperatorListContainsFilter
object
3 properties 3 required
GetMetricPropertiesRelationshipsResponseCollection
object
2 properties 1 required
GetMetricPropertyMetricRelationshipResponse
object
2 properties 1 required
MetricAggregateEnum
string
GetMappedMetricCustomMetricRelationshipResponse
object
2 properties 1 required
FlowEnum
string
CustomMetricPartialUpdateQueryResourceObject
object
3 properties 3 required
MetricResponseObjectResource
object
5 properties 4 required
MetricAggregateQuery
object
1 property 1 required
BooleanFilter
object
3 properties 3 required
CustomMetricCreateQuery
object
1 property 1 required
MetricEnum
string
GetCustomMetricMetricsRelationshipsResponseCollection
object
2 properties 1 required
PostCustomMetricResponse
object
2 properties 1 required
GetMetricResponseCompoundDocument
object
3 properties 1 required
StringInArrayFilter
object
3 properties 3 required
GetCustomMetricResponseCompoundDocument
object
3 properties 1 required
MappedMetricPartialUpdateQueryResourceObject
object
3 properties 2 required
ListSubstringFilter
object
3 properties 3 required
ObjectLinks
object
1 property 1 required
MappedMetricPartialUpdateQuery
object
1 property 1 required
NumericOperatorNumericFilter
object
3 properties 3 required
CollectionLinks
object
5 properties 1 required
FlowActionEnum
string
CustomMetricCondition
object
2 properties 2 required
CustomMetricResponseObjectResource
object
5 properties 4 required
MetricAggregateRowDTO
object
2 properties 2 required
PostMetricAggregateResponse
object
2 properties 1 required
GetMetricResponseCollectionCompoundDocument
object
3 properties 1 required
TagEnum
string
MappedMetricResponseObjectResource
object
5 properties 4 required
GetMetricResponseCollection
object
2 properties 1 required
CustomMetricCreateQueryResourceObject
object
2 properties 2 required
MetricPropertyResponseObjectResource
object
5 properties 4 required
GetMetricPropertyResponseCollection
object
2 properties 1 required
RelationshipLinks
object
2 properties 2 required
GetMappedMetricMetricRelationshipResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

klaviyo-metrics-api-openapi.yml Raw ↑

Other APIs Klaviyo publishes across the network.

Klaviyo Accounts API
Klaviyo Campaigns API
Klaviyo Catalogs API
Klaviyo Client API
Klaviyo Conversations API
Klaviyo Coupons API
Klaviyo Custom Objects API
Klaviyo Data Privacy API
Klaviyo Events API
Klaviyo Flows API
Klaviyo Forms API
Klaviyo Images API