GET
/
api
/
analytics
/
events
/
{event_id}

Authorizations

Authorization
string
headerrequired

Headers

TR-Dataset
string
required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Path Parameters

event_id
string
required

The event id to use for the request

Response

200 - application/json

EventData represents a single analytics event

created_at
string
required

The time the event was created.

dataset_id
string
required

The unique identifier for the dataset the event is associated with.

event_name
string
required

The name of the event, e.g. "Added to Cart", "Purchased", "Viewed Home Page", "Clicked", "Filter Clicked".

event_type
string
required

The type of event, "add_to_cart", "purchase", "view", "click", "filter_clicked".

id
string
required

The unique identifier for the event

is_conversion
boolean | null

Whether the event is a conversion event.

items
string[]
required

The items associated with the event. This could be a list of stringified json chunks for search events, or a list of items for add_to_cart, purchase, view, and click events.

metadata
any | null

Additional metadata associated with the event. This can be custom data that is specific to the event.

request_id
string | null

The unique identifier for the request the event is associated with.

request_type
string | null

The type of request the event is associated with.

updated_at
string
required

The time the event was last updated.

user_id
string | null

The user identifier associated with the event.

Get All User EventsSend CTR Data