v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB

Analytics

Get User Event By ID

This route allows you to view an user event by its ID. You can pass in any type of event and get the details for that event.

get/api/analytics/events/{event_id}

Path parameters

event_idstring uuid required

The event id to use for the request

Headers

TR-Datasetstring uuid 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.

Response

The event for the request

created_atstring required

The time the event was created.

dataset_idstring uuid required

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

event_namestring required

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

event_typestring required

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

idstring uuid required

The unique identifier for the event

is_conversionboolean nullable

Whether the event is a conversion event.

itemsstring[] 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.

{"stackTrail":"components:schemas:EventData:properties:metadata","oasType":"schema","type":"unknown","description":"Additional metadata associated with the event. This can be custom data that is specific to the event.","nullable":true}

request_idstring nullable

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

request_typestring nullable

The type of request the event is associated with.

updated_atstring required

The time the event was last updated.

user_idstring nullable

The user identifier associated with the event.

Example response

{
  "created_at": "2021-08-10T00:00:00Z",
  "dataset_id": "00000000-0000-0000-0000-000000000000",
  "event_name": "Viewed Home Page",
  "event_type": "view",
  "is_conversion": true,
  "items": [
    "item1",
    "item2"
  ],
  "metadata": "metadata",
  "request_id": "00000000-0000-0000-0000-000000000000",
  "updated_at": "2021-08-10T00:00:00Z",
  "user_id": "user1"
}