Get Metrics
GET {{baseUrl}}/api/metrics/
Get all metrics in an account.
Requests can be filtered by the following fields: integration name
, integration category
Request specific fields using sparse fieldsets.
Returns a maximum of 200 results per page, which can be paginated with cursor-based pagination
Rate limits:
Burst: 10/s
Steady: 150/m
Scopes:
Metrics Read
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
fields[metric] | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>integration.name : equals <br>integration.category : equals | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"metric","id":"cillum reprehenderit","attributes":{"name":"in","created":"ut eiusmo","updated":"amet","integration":{}},"links":{"self":"https://Nlh.fboylH4wwAFWXlHKrRCLu+Pr4SHgRWhD,er7qARai0"}},{"type":"metric","id":"in ut","attributes":{"name":"nostrud dolore ut est enim","created":"dolore ex ea irure","updated":"eu cupidatat","integration":{}},"links":{"self":"http://pnoeNjZmClYDiOlyvfbdrJqiQTyefgAT.lfyppWw0rm"}}],"links":{"self":"https://ngVwxZRohaAfGQhqPFtNf.bjbz0ZT9rwpHOtNNUEUiMZa7ecqCKfdudO","first":"http://tXjkIidqpjWTcMVLucqOTASOy.qrhvFV3.oQCbniUZvu77DJDqrlTkQCwcY.JptXee0J6GS.l-qo69rA","last":"http://NqnaPpxf.yjWcWkpiwzr5hH+HAn-j2E43xMNs1xNV,HvvKTvBAC0DFfkBPw,Qd7K13.i3NVM8H5a1I","prev":"https://e.dcuqkqqiCUohdkHubdtVl","next":"https://GRRGrTyjEKvZYKZd.nkxlf99v63RUaXFg6EqbWZ4qlHs"}}