Sign in

v1

latestOpenAPI 3.0.32026-07-2659199427.5 KB
Get signals

Query signals

When a user enters text to search your site, a query request is generated and the information is contained in a query signal.

post/retail/signals/query

Request body

timestampinteger required

The event time displayed in epoch time milliseconds.

visitorIdstring required

The unique identifier for the visitor (user) associated with the signal. The field is a UTF-8 encoded string with a maximum of 128 characters. Do not use personally identifiable information (PII) or user data in the value.

sessionIdstring required

The unique identifier that tracks a specific session of a user's activity over a period of time.

queryIdstring required

The unique identifier for the query.

ipAddressstring

This optional parameter is the IP address of the browser or device that generated the signal.

The IP address may be passed in the signal. If it is not passed in the signal, it is extracted from the request, and the last octet is dropped to mask the user's location for security purposes.

searchTermsstring required

The term or phrase entered in the user query that is captured in the signal.

sourceIdstring required

A freeform text field used to identify where the API call originates.

The value has no effect on search relevancy.

uristring required

The canonical URL of the product's detail page. The field is a UTF-8 encoded string with a maximum of 5000 characters.

Example request

[
  {
    "timestamp": 1744305461169,
    "visitorId": "abcc8e25-d30f-2212-9f60-9b45a71453cf",
    "sessionId": "41a50e2-8e32-4674-5429-e1450dfdbb14",
    "queryId": "2a97fc33-3335-3369-c2dc-456b775eb90f",
    "ipAddress": "111.222.333",
    "searchTerms": "silver french door bottom freezer refrigerator",
    "productDetails": [
      {
        "product": {
          "productId": "1234567",
          "price": 2592,
          "title": "Silver french door bottom freezer 27.4 cu ft refrigerator",
          "imageuri": "https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg"
        }
      }
    ],
    "uri": "https://example.com/refrigerators/silver/bottomfreezer"
  }
]

Response

ACCEPTED