Skip to main content
POST
/
logging
/
searchResultClick
Log search click
curl --request POST \
  --url https://api.thehaystack.ai/v2/haystack/logging/searchResultClick \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "queryAnalyticsId": "abc123def456",
  "itemId": 123,
  "position": 123,
  "clickPosition": "item",
  "clickThrough": true
}
'
{
  "success": true
}

Authorizations

Authorization
string
header
required

Enter your API token from the Haystack dashboard

Body

application/json
queryAnalyticsId
string
required
Example:

"abc123def456"

itemId
integer
required
position
integer
required

Zero-indexed position in results

clickPosition
enum<string>
Available options:
item,
highlight
clickThrough
boolean

Response

200 - application/json

Click logged

success
boolean