Overview

This page aims to gather all the fields/properties used from Hawksearch that are ultimately rendered on the frontend part of the Foundation demo project. Every area of interest is described by the fields present in the Hawksearch response, structured as a hierarchy.

Note: Under the Document object, we used fields defined in https://luminoslabs.atlassian.net/wiki/spaces/HC/pages/3718774833

Search / Landing / Category Page → Search API

• Pagination
  • NofResults
  • CurrentPage
  • MaxPerPage
  • Items
    • PageSize
    • Selected
• Results
  • Document
    • Price
    • Name
    • DisplayName
    • Description
    • ImageUrl
    • Url
• Keyword
• Redirect
  • Location
• Sorting
  • Items
    • Label
    • Value
    • Selected
• Facets
  • Field
  • Name
  • Values
    • Count
    • Label
    • Value
    • Selected
• Selections
  • Items
    • Value

Search Bar → Autocomplete API

• Products
  • Results
    • Document
      • Price
      • DisplayName
      • Description
      • ImageUrl
      • Url
• Content
  • Results
    • Document
      • Name
      • Description
      • ImageUrl
      • Url
• Popular
  • Value
  • Url
  • RawValue

Recommendations / Widget Block → Recommendation API

• WidgetItems
  • WidgetName
  • Html
  • RecommendationItems
    • ItemName
    • ImageUrl
    • Url
    • Price