| description | Use the Spotlight API to highlight key platform objects requiring attention. |
|---|
The Spotlight API provides endpoints designed to highlight key platform objects that may need attention. These objects can include agreements, orders, subscriptions, invoices, and more.
The API consists of two primary endpoints: spotlightObject and spotlightQuery. With this API, you can:
- List all spotlighted objects.
- Invalidate or clear the cache for Spotlight objects.
- List the defined spotlight queries.
- Get details for a specific spotlight query.
- Update an existing spotlight query.
Review the shared API docs before you work with the spotlight resources.
The Spotlight API is built around the following core resources:
- SpotlightObject – Represents a collection of spotlighted objects.
- SpotlightTopItem – Represents individual top result items identified by
spotlightQuery. - SpotlightQuery – Represents the search query used to retrieve spotlighted data.
The API is organized into a single collection containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.
Refer to the following capability matrix to see which roles are authorized to perform specific operations within this collection:
| Operation | Method | Description | Access |
|---|---|---|---|
| List spotlight objects | GET | Returns a list of spotlight result objects filtered by RQL query. | vendor, client, ops |
| Invalidate all cache | POST | Invalidates all cache keys for the account and buyer group. | vendor, client, ops |
| Invalidates cache | POST | Invalidates cache for a specific spotlight object. | vendor, client, ops |
| List spotlight queries | POST | Returns a list of spotlight queries. | vendor, client, ops |
| Get spotlight query | GET | Gets a spotlight query. | vendor, client, ops |
| Update spotlight query | PUT | Updates the definition or configuration of a spotlight query. | vendor, client, ops |