DEdevflowinc
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

Request

  • Base URL
    https://api.trieve.ai
  • URL
    https://api.trieve.ai/api/analytics/ctr
  • Auth
    API key in header Authorization

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
metadataunknown
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

Changes

No recorded changes to this operation across all 50 revisions of this API.