# SpotlightObject

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:

<table><thead><tr><th width="134">Field Name</th><th width="223">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The unique identifier for the spotlight object in this format: </p><p>Example: SPO-1234-5678-9547-1234-8888</p></td></tr><tr><td><code>query</code></td><td>object</td><td>A reference to the <a href="/pages/a54GQewZXPuL44o2ta0g">spotlightQuery</a> object.</td></tr><tr><td><code>top</code></td><td><a href="/pages/nQiKGl1wXvZr5MB8OZTi">spotlightTopItem</a></td><td>A list of the top five objects returned by the downstreamed RQL query.</td></tr><tr><td><code>total</code></td><td>integer</td><td>The total number of objects available for downstream RQL.</td></tr><tr><td><code>audit</code></td><td>object</td><td><p>The <a href="/pages/RnSJqP4ZqAW7vD2MWeVM"><code>audit</code></a> 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.</p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "updated": {
    "at": "2024-05 28T09:00:22.945Z",
}
</code></pre></td></tr></tbody></table>

## Example response <a href="#example" id="example"></a>

{% code lineNumbers="true" %}

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

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.platform.softwareone.com/developer-resources/rest-api/spotlight-objects-api/spotlight-object.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.