Get CTR Analytics

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

POST /api/analytics/events/ctr

Try it

Get CTR Analytics

cURL

curl --request POST \
  --url https://api.trieve.ai/api/analytics/events/ctr \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "type": "search_ctr_metrics",
  "filter": {
    "component_name": "<string>",
    "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": "<string>",
    "query_rating": {
      "gt": 1,
      "gte": 1,
      "lt": 1,
      "lte": 1
    },
    "search_method": "fulltext",
    "search_type": "search",
    "top_score": {
      "gt": 123,
      "gte": 123,
      "lt": 123,
      "lte": 123
    }
  }
}'

200

{
  "avg_position_of_click": 123,
  "percent_searches_with_clicks": 123,
  "percent_searches_without_clicks": 123,
  "searches_with_clicks": 123
}

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 filter the graph

SearchCTRMetrics

type · enum<string> · required

Available options: search_ctr_metrics

filter · object

Show child attributes

filter. component_name · string | null

filter. date_range · object

DateRange is a JSON object which can be used to filter chunks by a range of dates. This leverages the time_stamp field on chunks in your dataset. You can specify this if you want values in a certain range. You must provide ISO 8601 combined date and time without timezone.

Show child attributes

filter.date_range. gt · string | null

filter.date_range. gte · string | null

filter.date_range. lt · string | null

filter.date_range. lte · string | null

Example:

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

filter. query · string | null

filter. query_rating · object

Show child attributes

filter.query_rating. gt · integer<int32> | null

Required range: x >= 0

filter.query_rating. gte · integer<int32> | null

Required range: x >= 0

filter.query_rating. lt · integer<int32> | null

Required range: x >= 0

filter.query_rating. lte · integer<int32> | null

Required range: x >= 0

Example:

{ "gt": 1, "gte": 1, "lt": 1, "lte": 1 }

filter. search_method · enum<string>

Available options: fulltext, semantic, hybrid, bm25

filter. search_type · enum<string>

Available options: search, autocomplete, search_over_groups, search_within_groups

filter. top_score · object

Show child attributes

filter.top_score. gt · number<double> | null

filter.top_score. gte · number<double> | null

filter.top_score. lt · number<double> | null

filter.top_score. lte · number<double> | null

Response

200

application/json

The CTR analytics for the dataset

Search CTR Metrics

avg_position_of_click · number<double> · required

percent_searches_with_clicks · number<double> · required

percent_searches_without_clicks · number<double> · required

searches_with_clicks · integer<int64> · required