Track Search Query
Record a search query event for analytics.
Documentation Index
Fetch the complete documentation index at: https://cludo.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
SiteKey authentication. Pass the full value including the SiteKey prefix: SiteKey <base64(customerId:engineId:searchKey)>. Example: SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1.
Path Parameters
Must match the customer id used in the search that produced qid.
Must match the engine id in the same search request path.
Body
Flat key-value payload for a search query analytics event (not wrapped in a values object).
The search query string the user submitted.
QueryId copied from the search JSON response.
The pixel resolution of the visitor's screen (e.g. 1920x1080).
The browser user-agent string.
The URL of the page that referred the user to the search results.
The title of the page the query originated from
The browser language.
The page number of the results the user was viewing.
The hostname of the page the query originated from.
The number of results returned in the search response.
Spell-corrected query from FixedQuery when the user saw the corrected version.
The number of banners shown in the search results.
The IDs of the banners that were displayed in the search results.
The server-side processing time in milliseconds.
The ID of the quicklink that triggered the search.
The session ID (cookie or generated) to stitch multiple events per visit.
A unique string used as the ID of the query session.
The device class for analytics segmentation.
mobile, tablet, desktop Response
Search query event recorded.
Success response containing the server-generated tracking ID.
Unique identifier for the recorded tracking event.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

