v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB
Analytics

Get All User Events

This route allows you to view all user events.

post/api/analytics/events/all

Request body

pageinteger nullable

Page of results to return

Example request

{
  "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"
  }
}

Response

The events for the request

Example response

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