Spotlight Query

A Spotlight Query defines the RQL query used to retrieve spotlighted objects from a collection.

This object contains the following attributes:

Field	Type	Description
id	string	Unique ID for the query itself. Example: SPQ-9878-8864
name	string	Name of the query (core property).
template	string	Name of the UI template used to render data (core property).
invalidation	invalidationStructure	Settings for invalidating cached data.
interval	string	Interval for invalidating cached data.

Example

SPOTLIGHT QUERY

{
  "id": "SPQ-1234-2345",
  "name": "Saved Orders",
  "template": "savedOrdersClient"
  "invalidation": {
    "interval": "1:00:00"
  }
}