For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

The unique ID for the query itself.

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

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

Last updated

Was this helpful?