Skip to main content
POST
Log search click

Authorizations

Authorization
string
header
required

Enter your API token from the Haystack dashboard

Body

application/json
searchId
string
required

The encoded search id returned on GET /search as queryAnalyticsId

itemId
integer
required
position
integer
required

Zero-indexed position of the clicked result

surface
enum<string>
required
Available options:
embed,
connect,
console
clickedHighlight
boolean

True if the user clicked a highlighted transcript snippet rather than the item card

embedToken
string

Required when surface=embed

Response

200 - application/json

Click logged

clickId
string<uuid>