v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB

Dataset

Get events for the dataset

Get events for the dataset specified by the TR-Dataset header.

post/api/dataset/events

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.

Request body

event_typesEventTypeRequest[] nullable

The types of events to get. Leave undefined to get all events.

pageinteger nullable

The page number to get. Default is 1.

page_sizeinteger nullable

The number of items per page. Default is 10.

Example request

{
  "page": 1,
  "page_size": 10,
  "type": [
    "chunk_action_failed"
  ]
}

Response

Events for the dataset

event_typesstring[] required

page_countinteger required

Example response

{
  "events": [
    {
      "created_at": "2021-01-01 00:00:00.000",
      "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "event_data": {
        "file_name": "file.txt",
        "group_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
      },
      "event_type": "file_uploaded",
      "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "updated_at": "2021-01-01 00:00:00.000"
    }
  ]
}