Optional
requestFactory: DashboardsApiRequestFactoryOptional
responseProcessor: DashboardsApiResponseProcessorPrivate
configurationPrivate
requestPrivate
responseThe request object
Optional
options: ConfigurationShare a specified private dashboard, generating a URL at which it can be publicly viewed.
The request object
Optional
options: ConfigurationDelete a dashboard using the specified ID.
The request object
Optional
options: ConfigurationDelete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed).
The request object
Optional
options: ConfigurationRevoke the public URL for a dashboard (rendering it private) associated with the specified token.
The request object
Optional
options: ConfigurationRevoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses.
The request object
Optional
options: ConfigurationGet a dashboard using the specified ID.
The request object
Optional
options: ConfigurationFetch an existing shared dashboard's sharing metadata associated with the specified token.
The request object
Optional
options: ConfigurationDescribe the invitations that exist for the given shared dashboard (paginated).
The request object
Optional
options: ConfigurationGet all dashboards.
Note: This query will only return custom created or cloned dashboards. This query will not return preset dashboards.
The request object
Optional
options: ConfigurationProvide a paginated version of listDashboards returning a generator with all the items.
Optional
options: ConfigurationRestore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed).
The request object
Optional
options: ConfigurationSend emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list.
The request object
Optional
options: ConfigurationUpdate a dashboard using the specified ID.
The request object
Optional
options: ConfigurationUpdate a shared dashboard associated with the specified token.
The request object
Optional
options: ConfigurationGenerated using TypeDoc
Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the
as_count()
oras_rate()
modifiers appended. Refer to the following documentation for more information on these modifiers.