API reference
Metrics API
The kinds of event the account records, such as Placed Order, and their aggregates.
Endpoints
- GETList custom metrics/api/custom-metrics
- POSTCreate a custom metric/api/custom-metrics
- GETList mapped metrics/api/mapped-metrics
- POSTCounts, sums and unique people for a metric over time/api/metric-aggregates
- GETList metrics/api/metrics
- GETGet a custom metric/api/custom-metrics/{id}
- PATCHUpdate a custom metric/api/custom-metrics/{id}
- DELDelete a custom metric/api/custom-metrics/{id}
- GETGet a mapped metric/api/mapped-metrics/{id}
- PATCHMap a role to a metric or custom metric/api/mapped-metrics/{id}
- GETGet a metric property/api/metric-properties/{id}
- GETGet a metric/api/metrics/{id}
- GETList the metrics a custom metric combines/api/custom-metrics/{id}/metrics
- GETGet the custom metric of a mapped metric/api/mapped-metrics/{id}/custom-metric
- GETGet the metric of a mapped metric/api/mapped-metrics/{id}/metric
- GETGet the metric of a metric property/api/metric-properties/{id}/metric
- GETList the flows a metric starts/api/metrics/{id}/flow-triggers
- GETList a metric's properties/api/metrics/{id}/metric-properties
- GETList the ids of the metrics a custom metric combines/api/custom-metrics/{id}/relationships/metrics
- GETGet the custom metric id of a mapped metric/api/mapped-metrics/{id}/relationships/custom-metric
- GETGet the metric id of a mapped metric/api/mapped-metrics/{id}/relationships/metric
- GETGet the metric id of a metric property/api/metric-properties/{id}/relationships/metric
- GETList the ids of the flows a metric starts/api/metrics/{id}/relationships/flow-triggers
- GETList the ids of a metric's properties/api/metrics/{id}/relationships/metric-properties
Access
A private key with these scopes reaches every endpoint here. Each endpoint page lists the scopes it needs.
flows:readmetrics:readmetrics:writeCoverage
24 of the 24 operations in this area of Klaviyo's API are built here.
Complete
Every operation in this area of Klaviyo's API is built.