Sample Search Requests

Semantic Search

Request

{
  "query": {
    "text": "dress",
    "filters": [
      {
        "field": "categories",
        "values": ["dresses", "tops"]
      },
      {
        "field": "price",
        "min": 100,
        "max": 200
      }
    ],
    "pagination": {
      "numItems": 24,
      "offset": 0
    },
    "user": {
      "active_consent_accepted": true,
      "dyid": "12264556113"
    },
    "session": {
      "dy": "3124353434443123"
    },
    "context": {
      "page": {
        "type": "HOMEPAGE",
        "location": "https://shop.biz/nice-shirt-p76311.html",
        "referrer": "https://google.cz",
        "locale": "en_US"
      }
    },
    "selector": {
      "name": "Semantic Search"
    },
    "options": {
      "returnAnalyticsMetadata": false,
      "isImplicitClientData": false,
      "isImplicitKeywordEvent": true
    }
  }
}

Note: A Visual Search request follows the same structure, except it does not support pagination.

Visual & Semantic Search Response

{
  "id": 24,
  "name": "Visual Search",
  "type": "VISUAL_SEARCH_DECISION",
  "decisionId": "d29ybGQK",
  "variations": [
    {
      "id": 203,
      "payload": {
        "type": "SEARCH",
        "data": {
          "totalNumResults" : 1000,
          "spellCheckedQuery": "Red Dress"
          "facets": [{
              "column": "color",            
              "valuesType": "string",
              "displayName": "Color",
              "values": [
                {
                  "name": "Black dark",
                  "count": 560
                },
                {
                  "name": "White dusty light",
                  "count": 191
                }
              ]
            }
          }],
          "slots": [
            {
              "slotId": "aGVsbG93b3JsZAo=",
              "sku": "SKU_C",
            },
            {
              "slotId": "d2VsY29tZWR1ZAo=",
              "sku": "SKU_A"
            },
            {
              "slotId": "d2VsY29tZWR1ZAo=",
              "sku": "SKU_B"
            }
          ]
        }
      }
    }
  ]
}

Shopping Muse

Request

{ 
  "query": { 
    "text": "Modern summer office dresses are a great choice! Let’s explore some chic options.", 
    "chatId": "gAAAAABn85XBEaWKxRxEABWj2P2E8VecQcjXv8qvaZEOs-PlP1Lbt8b4VjHvo1xWOmHTNF-QlD", 
    "user": { 
      "active_consent_accepted": true, 
      "dyid": "12264556113" 
    }, 
    "session": { 
      "dy": "3124353434443123" 
    }, 
    "context": { 
      "page": { 
        "type": "HOMEPAGE", 
        "location": "https://shop.biz/nice-shirt-p76311.html", 
        "referrer": "https://google.cz", 
        "locale": "en_US" 
      } 
    }, 
    "selector": { 
      "name": "Shopping Muse" 
    }, 
    "options": { 
      "returnAnalyticsMetadata": false, 
      "isImplicitClientData": false, 
      "isImplicitKeywordEvent": true 
    } 
  } 
}

Response

{ 
  "id": 74, 
  "name": "Shopping Muse", 
  "type": "SHOPPING_MUSE_DECISION", 
  "decisionId": "d29ybGQK", 
  "variations": [ 
    { 
      "id": 28453806, 
      "payload": { 
        "data": { 
          "assistant": "Modern summer office dresses are a great choice! Let’s explore some chic options.", 
          "support": false, 
          "chatId": "gAAAAABnD34yb0Q5RLo8nmcpo5GikahgDh0i-zKjn7VNWdI-HlObaZTdvxENLnFPCNzjp", 
          "widgets": [ 
            { 
              "title": "the widget title", 
              "slots": [ 
                { "slotId": "aGVsbG93b3JsZAo=", "sku": "SKU_1" }, 
                { "slotId": "d2VsY29tZWR1ZAo=", "sku": "SKU_2" }, 
                { "slotId": "d2VsY29tZWR1ZAo=", "sku": "SKU_3" }, 
                { "slotId": "d2VsY29tZWR1ZAo=", "sku": "SKU_4" }, 
                { "slotId": "d2VsY29tZWR1ZAo=", "sku": "SKU_5" }, 
                { "slotId": "d2VsY29tZWR1ZAo=", "sku": "SKU_6" }, 
                { "slotId": "d2VsY29tZWR1ZAo=", "sku": "SKU_7" }, 
                { "slotId": "d2VsY29tZWR1ZAo=", "sku": "SKU_8" } 
              ] 
            } 
          ] 
        } 
      } 
    } 
  ], 
  "cookies": [ 
    { 
      "name": "_dyid_server", 
      "value": "-6980579180165266393", 
      "maxAge": "31556926" 
    }, 
    { 
      "name": "_dyjsession", 
      "value": "tsw56se9ix1w5hqk1o3o6c7qlpx9j9e7", 
      "maxAge": "1800" 
    } 
  ] 
}