Skip to main content
POST
/
api
/
analytics
/
events
/
all
Get All User Events
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
}
'
{
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.trieve.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

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

The events for the request

Response body for the GetEvents endpoint

​
events
EventData · object[]
required