POST
/
retail
/
signals
/
query
Query signals
curl --request POST \
  --url https://{SIGNAL_STORE_ID}.applications.lucidworks.com/retail/signals/query \
  --header 'Accept: <accept>' \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '[
  {
    "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",
          "currencyCode": "USD",
          "price": 2592,
          "title": "Silver french door bottom freezer 27.4 cu ft refrigerator",
          "imageuri": "https://example.com/images/refrigerators/silver/bottomfreezer/1234567.jpg"
        },
        "quantity": 123
      }
    ],
    "sourceId": "<string>",
    "uri": "https://example.com/refrigerators/silver/bottomfreezer"
  }
]'

Headers

​
Accept
string
default:application/json
required

Header acceptance criteria

Example:

"application/json"

​
Authorization
string
default:{EMBED_TOKEN}
required

This is the Lucidworks Platform Analytics Studio embed token generated after the signal store is created. To obtain the embed token: 1. Sign in to Lucidworks Platform, click Analytics Studio and then click the signal store. 2. Click Integrations > Signals Using Embed Token. 3. If the token is not generated, click Generate. The embed token displays on the screen and also in all of the cURL examples. 4. Copy that token to paste into your codebase.

Example:

"qasdlkjdoiu1123455WECMMLLJ22eeg"

​
Content-Type
string
default:application/json
required

Content type format

Example:

"application/json"

Body

application/json · RetailQuery · object[]

The body is of type RetailQuery · object[].