Spotlight Object

A SpotlightObject represents an instance of spotlighted objects collections and its definition, along with RQL query definition used to retrieve items.

Field	Type	Description
id	string	The unique identifier for the spotlight object in this format: SPO-<QQQQ>-<QQQQ>-<XXXX>-<XXXX>-<XXXX>
query	SpotlightQuery	The spotlight query object.
top	List<SpotlightTopItem>	List of the top 5 objects returned by the downstreamed RQL query.
total	int	Total number of objects available for downstream RQL.
audit	AuditObject	The audit information object. This object keeps track of changes to the spotlight object. Mainly when the cache key was refreshed for the last time, and by whom the action was initiated. Example: { "updated": { "at": "2024-05-28T09:00:22.945Z", }blic/accounts/acc-8989-32321.jpg", }

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",
      "href": "/public/v1/commerce/orders/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"
    }
  }
}