IListedDashboard

IListedDashboard.availabilitypropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

States if dashboard is shared with the user and fully accessible or if it is hidden but accessible via link if user knows it.

readonly availability: ListedDashboardAvailability;

IListedDashboard.descriptionpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Dashboard description

readonly description: string;

IListedDashboard.identifierpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Dashboard identifier

readonly identifier: string;

IListedDashboard.refpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Dashboard object ref

readonly ref: ObjRef;

IListedDashboard.summarypropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

AI-generated summary of the dashboard content.

readonly summary?: string;

Remarks

Optional for backward compatibility as not all backends/sources provide it.

IListedDashboard.tabspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Tabs configuration for multi-tabbed dashboards.

readonly tabs?: IDashboardTab[];

Remarks

When present, indicates the dashboard supports tabbed navigation with each tab having its own layout and filter context. This property is only populated when querying dashboard listings, providing quick access to tab metadata without loading the full dashboard definition.

IListedDashboard.tagspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Dashboard tags.

readonly tags?: string[];

Remarks

This property is optional for backwards compatibility reasons, but for newly created dashboards, you can expect this to always be defined (an empty array in case there are no tags).

Since 8.6.0

IListedDashboard.titlepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Dashboard title

readonly title: string;

IListedDashboard.uripropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Dashboard uri

readonly uri: string;