Sign in

v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB
Analytics

Get RAG Analytics

This route allows you to view the RAG analytics for a dataset.

post/api/analytics/rag

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

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "filter": {
    "date_range": {
      "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"
    },
    "query_rating": {
      "gt": 1,
      "gte": 1,
      "lt": 1,
      "lte": 1
    }
  }
}

Response

The RAG analytics for the dataset

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

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