Skip to main content
POST
List the records behind a dashboard element

Path Parameters

id
string<uuid>
required

Body

application/json
componentId
string
required

The component whose record query the click explains.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$
selection
object
required
revision
integer

Loaded revision; omission reads the current one.

Required range: -9007199254740991 < x <= 9007199254740991
timeRange
object

The viewer's window; omission uses the revision's default.

componentTimeRanges
object

A component's own window for this read, over its saved timeRange and over timeRange.

variables
object

The viewer's variable picks, applied to the component's query.

limit
integer

Most records to return; 200 when omitted.

Required range: 1 <= x <= 200
projectId
string<uuid>

Project that owns the dashboard. Auto-filled from CLI and SDK context when omitted.

Response

200 - application/json

OK

status
any
required
componentId
string
required
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$
matched
object[]
required
records
object[]
required
truncated
boolean
required