v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB

Analytics

Get Search Analytics

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

post/api/analytics/search

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

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 search analytics for the dataset

OR

OR

OR

OR

OR

OR

OR

OR

OR

OR

OR

OR

OR

OR

OR

Example response

{
  "total_queries": [
    {
      "search_count": 8,
      "search_type": "search"
    }
  ]
}