Spotlight Query

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

This object contains the following attributes:

Field Name
Data Type
Description

id

string

The unique ID for the query itself.

Example: SPQ-9878-8864

name

string

The name of the query (core property).

template

string

The 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 response

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

Last updated

Was this helpful?