List dashboards

⚠️ Alpha — under active development; may change without notice.

Returns a paginated list of dashboards the caller can read. List items
include envelope metadata only (no definition). Default page size is
100; maximum is 100. Default ordering is name ascending, then id
ascending.

Set expand=true to populate display fields on createdBy and
updatedBy, and record on managedBy. Without expand, references
contain only id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

CEL expression to filter results.

Identity and content: id (int in CEL, string in JSON), name,
description (string), visibility (Listed or Hidden).

Audit: createdAt, updatedAt (timestamp); createdBy.id,
updatedBy.id (user id, int).

Owner reference: managedBy.id (int); managedBy.record.label,
managedBy.record.description (string). These are filterable even
without expand=true — expand controls what is returned, not
what can be filtered.

Facets (filter-only, not sortable):

FieldCEL typeNotes
objectTagsmap(string, list(string))User-applied tags, as a map of tag key to a list of values.
parameters.correlationTagslist(string)Correlation-tag names picked by the dashboard's correlationTag-kind parameters.
parameters.resources.idslist(int)Dataset ids picked by the dashboard's resource-kind parameters.
parameters.resources.nameslist(string)Dataset names for the same resource-kind parameters.
queries.inputs.idslist(int)Dataset ids bound to the dashboard's query-card inputs.
queries.inputs.nameslist(string)Dataset names for the same query-card inputs.
datasetFilter.idint, nullableThe primary dataset filter's dataset id, when set.
datasetFilter.namestring, nullableThe primary dataset filter's dataset name, when set.

Supports matches() for regex. Example: name.matches("prod.*").

string

CSV list of CEL expressions, each producing a comparable value.
Prefix an item with - for descending order. Default sort is
name ascending, then id ascending.

Sortable fields: id, name, description, visibility,
createdAt, updatedAt, createdBy.id, updatedBy.id, managedBy.id.
Facet fields (objectTags, parameters.*, queries.*,
datasetFilter.*) cannot be sorted.

CSV-escape first, then URL-encode. Wrap an item in " if it contains
a comma or "; double a literal " to "" inside a quoted item.

int64
≥ 0

Number of items to skip before starting to collect the result set.

int64
1 to 100

Maximum number of items to return in the response. Capped at 100.

boolean

Whether to expand resources referenced in the response to include additional fields

Responses

Language
Credentials
Bearer
Authorization: Bearer <customerid> <apitoken>
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json