Get Events
GET {{baseUrl}}/api/events/
Get all events in an account
Requests can be sorted by the following fields:
datetime, timestamp
Include parameters can be provided to get the following related resource data: metric, profile
Returns a maximum of 200 events per page.
Rate limits:
Burst: 350/s
Steady: 3500/m
Scopes:
events:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[event] | string | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | |
fields[metric] | string | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | |
fields[profile] | string | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>metric_id: equals<br>profile_id: equals<br>datetime: greater-or-equal, greater-than, less-or-equal, less-than<br>timestamp: greater-or-equal, greater-than, less-or-equal, less-than | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#relationships | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#pagination | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2023-08-15/reference/api-overview#sorting |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"event","id":"\u003cstring\u003e","attributes":{"timestamp":"\u003cinteger\u003e","event_properties":{},"datetime":"\u003cstring\u003e","uuid":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"profile":{"data":{"type":"profile","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"metric":{"data":{"type":"metric","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"event","id":"\u003cstring\u003e","attributes":{"timestamp":"\u003cinteger\u003e","event_properties":{},"datetime":"\u003cstring\u003e","uuid":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"profile":{"data":{"type":"profile","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"metric":{"data":{"type":"metric","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"},"included":[{"type":"metric","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","created":"\u003cstring\u003e","updated":"\u003cstring\u003e","integration":{}},"links":{"self":"\u003curi\u003e"}},{"type":"metric","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","created":"\u003cstring\u003e","updated":"\u003cstring\u003e","integration":{}},"links":{"self":"\u003curi\u003e"}}]}