Spotlight Object

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

Field
Type
Description

id

string

The unique identifier for the spotlight object in this format:

Example: SPO-1234-5678-9547-1234-8888

query

A reference to the spotlight query object.

top

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

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",
}

Example

{
  "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"
    }
  }
}

Last updated

Was this helpful?