Get All User Events

This route allows you to view all user events.

POST /api/analytics/events/all

Try it

Get All User Events

cURL

curl --request POST \
  --url https://api.trieve.ai/api/analytics/events/all \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter": {
    "date_range": {
      "gt": "2021-08-10T00:00:00Z",
      "lt": "2021-08-11T00:00:00Z"
    },
    "event_type": "view",
    "is_conversion": true,
    "metadata_filter": "path = \"value\"",
    "user_id": "user1"
  },
  "page": 1
}'

200

{
  "events": [
    {
      "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"
    }
  ]
}

Authorizations

Authorization · string · header · required

Body

application/json

JSON request payload to filter the events

filter · object

Filter to apply to the events when querying for them

Show child attributes

filter. date_range · object

DateRange is a JSON object which can be used to filter chunks by a range of dates. This leverages the time_stamp field on chunks in your dataset. You can specify this if you want values in a certain range. You must provide ISO 8601 combined date and time without timezone.

Show child attributes

filter.date_range. gt · string | null

filter.date_range. gte · string | null

filter.date_range. lt · string | null

filter.date_range. lte · string | null

Example:

{
  "gt": "2021-01-01 00:00:00.000",
  "gte": "2021-01-01 00:00:00.000",
  "lt": "2021-01-01 00:00:00.000",
  "lte": "2021-01-01 00:00:00.000"
}

filter. event_type · enum<string>

Available options: view, filter_clicked, click, add_to_cart, purchase

filter. is_conversion · boolean | null

Filter by conversions

filter. metadata_filter · string | null

Filter by metadata path i.e. path.attribute = "value"

filter. user_id · string | null

Filter by user ID

Example:

{
  "date_range": {
    "gt": "2021-08-10T00:00:00Z",
    "lt": "2021-08-11T00:00:00Z"
  },
  "event_type": "view",
  "is_conversion": true,
  "metadata_filter": "path = \"value\"",
  "user_id": "user1"
}

page · integer<int32> | null

Page of results to return

Required range: x >= 0

Response

200

application/json

The events for the request

Response body for the GetEvents endpoint

events · EventData · object[] · required

Show child attributes

events. created_at · string · required

The time the event was created.

events. dataset_id · string<uuid> · required

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

events. event_name · string · required

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

events. event_type · string · required

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

events. id · string<uuid> · required

The unique identifier for the event

events. 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.

events. updated_at · string · required

The time the event was last updated.

events. is_conversion · boolean | null

Whether the event is a conversion event.

events. metadata · any | null

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

events. request_id · string | null

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

events. request_type · string | null

The type of request the event is associated with.

events. user_id · string | null

The user identifier associated with the event.