SearchResponse

data
Type: object · SearchResponseBody
required
- products
  Type: array object[] · Products
  required
  
  The search results.
- spellcheck
  Type: object · Spellcheck
  required
  
  Spellcheck results. You can use the information in this object to prompt users with the correct spelling.
- start
  Type: integer · Start
  required
  
  Starting offset of the search results.
- total
  Type: integer · Total
  required
  
  Total number of search hits.
- boosting_rules
  Type: array · Boosting Rules
  
  Boosting rules that are applied to the search results.
- custom_assets
  Type: array object[] · Custom Assets
  
  Custom JSON assets uploaded in Dojo.
  
  Empty object
- facet_counts
  Type: object · Facet Counts
  
  Facet counts
- filtering_rule
  Type: string · Filtering Rule
  
  Filter query that is applied to the search results.
- miso_id
  Type: string · Miso IdFormat: uuid
  
  Miso-generated unique Id for each recommendation or search result. Maintaining this Id for subsequent page views is important to Miso's performance as we use miso_id to track and fine-tune the performance of personalization and search results. When a user clicks on a recommendation or search result, you should pass the associated miso_id to the next page view, and associate the miso_id with the interactions that take place on the page (e.g. product_detail_page_view, add_to_cart, add_to_collection, like, etc.). In this way, Miso will learn which recommendations work and which didn't.
  
  Example:
  
  {"misoId": "123e4567-e89b-12d3-a456-426614174000"}
- partially_matched_products
  Type: array object[] · Partially Matched Products
  
  The search results that only partially match the search query.
- product_existence
  Type: object · Product Existence
  
  Product existence query result
- took
  Type: integer · Took
  
  Number of milliseconds Miso took to retrieve the results.
message
Type: string · Message