Send CTR Data

This route allows you to send clickstream data to the system. Clickstream data is used to fine-tune the re-ranking of search results and recommendations.

PUT /api/analytics/ctr

Try it

Send CTR Data

cURL

curl --request PUT \
  --url https://api.trieve.ai/api/analytics/ctr \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "ctr_type": "search",
  "position": 123,
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clicked_chunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clicked_chunk_tracking_id": "<string>",
  "metadata": "<unknown>"
}'

400

{
  "message": "Bad Request"
}

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 send CTR data

ctr_type · enum<string> · required

Available options: search, rag, recommendation

position · integer<int32> · required

The position of the clicked chunk

request_id · string<uuid> · required

The request id for the CTR data

clicked_chunk_id · string<uuid> | null

The ID of chunk that was clicked

clicked_chunk_tracking_id · string | null

The tracking ID of the chunk that was clicked

metadata · any | null

Any metadata you want to include with the event i.e. action, user_id, etc.

Response

204

The CTR data was successfully sent