Get Event
GET {{baseUrl}}/api/events/:id/
Get an event with the given event ID.
Include parameters can be provided to get the following related resource data: metrics, profiles
Rate limits:
Burst: 10/s
Steady: 150/m
Scopes:
events:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[event] | string | For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets | |
fields[metric] | string | For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets | |
fields[profile] | string | For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#sparse-fieldsets | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2023-06-15/reference/api-overview#relationships |
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":{"metric_id":"\u003cstring\u003e","profile_id":"\u003cstring\u003e","timestamp":"\u003cstring\u003e","event_properties":{},"datetime":"\u003cstring\u003e","uuid":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"profiles":{"data":[{"type":"profile","id":"\u003cstring\u003e"},{"type":"profile","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"metrics":{"data":[{"type":"metric","id":"\u003cstring\u003e"},{"type":"metric","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\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"}}]}