Skip to main content
PUT
Send CTR Data

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

The CTR data was successfully sent