Skip to main content
POST
/
api
/
dataset
/
events
Get events for the dataset
curl --request POST \
  --url https://api.trieve.ai/api/dataset/events \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "page": 1,
  "page_size": 10,
  "type": [
    "chunk_action_failed"
  ]
}'
{
  "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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Dataset
string<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.

Body

application/json

JSON request payload to get events for a dataset

​
event_types
enum<string>[] | null

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

Available options:
file_uploaded,
file_upload_failed,
chunks_uploaded,
chunk_action_failed,
chunk_updated,
bulk_chunks_deleted,
chunk_update_failed,
dataset_delete_failed,
qdrant_upload_failed,
bulk_chunk_upload_failed,
group_chunks_updated,
group_chunks_action_failed,
crawl_completed,
crawl_failed,
crawl_started,
csv_jsonl_processing_failed,
csv_jsonl_processing_checkpoint,
csv_jsonl_processing_completed,
video_uploaded,
pagefind_indexing_started,
pagefind_indexing_finished,
etl_started,
etl_completed,
etl_failed
​
page
integer<int64> | null

The page number to get. Default is 1.

​
page_size
integer<int64> | null

The number of items per page. Default is 10.

Response

Events for the dataset

​
event_types
string[]
required
​
events
object[]
required
Example:
{
  "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"
}
​
page_count
integer<int32>
required