Track Search Query

Record a search query event for analytics.

POST /api/v3/{customerId}/{engineId}/search/pushstat/querylog

Track Search Query

cURL

curl --request POST \
  --url https://api.cludo.com/api/v3/{customerId}/{engineId}/search/pushstat/querylog \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sw": "<string>",
  "qid": "<string>",
  "sz": "<string>",
  "ua": "<string>",
  "refurl": "<string>",
  "refpt": "<string>",
  "brl": "<string>",
  "pn": "<string>",
  "hn": "<string>",
  "rc": "<string>",
  "fquery": "<string>",
  "ban": "<string>",
  "bnrs": "<string>",
  "rt": "<string>",
  "ql": "<string>",
  "sid": "<string>",
  "qsid": "<string>"
}
'

200

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Authorizations

SiteKeyBasicAuth

Authorization · string · header · required

SiteKey authentication. Pass the full value including the SiteKey prefix: SiteKey <base64(customerId:engineId:searchKey)>. Example: SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1.

Path Parameters

customerId · integer · required

Must match the customer id used in the search that produced qid.

engineId · integer · required

Must match the engine id in the same search request path.

Body

application/json

Flat key-value payload for a search query analytics event (not wrapped in a values object).

sw · string · required

The search query string the user submitted.

qid · string · required

QueryId copied from the search JSON response.

sz · string

The pixel resolution of the visitor's screen (e.g. 1920x1080).

ua · string

The browser user-agent string.

refurl · string

The URL of the page that referred the user to the search results.

refpt · string

The title of the page the query originated from

brl · string

The browser language.

pn · string

The page number of the results the user was viewing.

hn · string

The hostname of the page the query originated from.

rc · string

The number of results returned in the search response.

fquery · string

Spell-corrected query from FixedQuery when the user saw the corrected version.

ban · string

The number of banners shown in the search results.

bnrs · string

The IDs of the banners that were displayed in the search results.

rt · string

The server-side processing time in milliseconds.

ql · string

The ID of the quicklink that triggered the search.

sid · string

The session ID (cookie or generated) to stitch multiple events per visit.

qsid · string

A unique string used as the ID of the query session.

dt · enum<string>

The device class for analytics segmentation.

Available options: mobile, tablet, desktop

Response

200

application/json

Search query event recorded.

Success response containing the server-generated tracking ID.

id · string

Unique identifier for the recorded tracking event.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"