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 '{
"clicked_chunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clicked_chunk_tracking_id": "<string>",
"ctr_type": "search",
"metadata": "<any>",
"position": 123,
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
This response does not have an example.
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.
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 '{
"clicked_chunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clicked_chunk_tracking_id": "<string>",
"ctr_type": "search",
"metadata": "<any>",
"position": 123,
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
This response does not have an example.
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.
JSON request payload to send CTR data
The body is of type object
.
The CTR data was successfully sent
Was this page helpful?