v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB

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

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

clicked_chunk_idstring uuid nullable

The ID of chunk that was clicked

clicked_chunk_tracking_idstring nullable

The tracking ID of the chunk that was clicked

ctr_type'search' | 'rag' | 'recommendation' required

{"stackTrail":"components:schemas:CTRDataRequestBody:properties:metadata","oasType":"schema","type":"unknown","description":"Any metadata you want to include with the event i.e. action, user_id, etc.","nullable":true}

positioninteger required

The position of the clicked chunk

request_idstring uuid required

The request id for the CTR data

Response

The CTR data was successfully sent