Analytics
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
Authorizations
Authorization
string
headerrequiredHeaders
TR-Dataset
string
requiredThe 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
ctr_type
enum<string>
requiredAvailable options:
search
, rag
, recommendation
position
integer
requiredThe position of the clicked chunk
request_id
string
requiredThe request id for the CTR data
clicked_chunk_id
string | 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.