Spotlight

The Spotlight object represents a collection of spotlighted objects and their definition, along with the RQL query used to retrieve items.

This object contains the following attributes:

Field	Type	Description
id	string	The unique identifier for the spotlight object.
query	object	Represents the spotlightQuery object.
top	spotlightTopItem	A list of the top five objects returned by the downstreamed RQL query.
total	integer	The total number of objects available for downstream RQL.
audit	object	Represents the audit object, which tracks changes to the spotlight object. For example, when the cache key was last refreshed and who initiated the action.

Example

SPOTLIGHT OBJECT

{
  "id": "SPO-1234-5678-9012-3456-7890",
  "query": {
    "id": "SPQ-1234-2345",
    "name": "Saved Orders",
    "template": "savedOrdersClient"
  },
  "top": [
    {
      "id": "ORD-6637-5331-9984",
      "audit": {
        "updated": {
          "at": "2024-05-28T09:00:22.945Z"
        }
      },
      "icon": "/public/v1/catalog/products/PRD-6523-2229/icon",
      "name": "Order ORD-8373-6076-7130"
    }
  ],
  "total": 1,
  "audit": {
    "updated": {
      "at": "2024-05-28T09:00:22.945Z"
    }
  }
}