Get dashboard
Retrieves a single dashboard.
Also supports retrieving archived dashboards via the archived query parameter. Retrieving archived dashboards requires the requesting user to be the dashboard owner, a reporting admin, or a super admin.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The ID of the dashboard to retrieve.
Query Parameters
Whether to retrieve an archived dashboard instead of an active one. Default false.
Additionally properties to include in the response. Refer to the response details for available fields.
Response
successful operation
Whether the dashboard is archived.
The ID of the business unit that the dashboard is associated with.
The date and time when the dashboard was created, in ISO 8601 format.
The ID of the dashboard.
The name of the dashboard.
The date and time when the dashboard was last updated, in ISO 8601 format.
If the dashboard is archived, the date and time when the dashboard was archived, in ISO 8601 format. Absent if the dashboard is not archived.
The ID of the user who created the dashboard. May be absent.
A description of the dashboard. May be absent.
The date and time when the dashboard was last viewed, in ISO 8601 format. Absent if it has not been viewed yet.
The ID of the user who last viewed the dashboard. Absent if it has not been viewed yet.
The ID of the user who owns the dashboard. Absent if the dashboard is currently unowned.
Array of objects representing the tags that the dashboard is tagged with.
Only returned when requested by including the tags field in the properties query parameter.
The ID of the user who last updated the dashboard. May be absent.
An array of objects representing the widgets on the dashboard.
Only returned when requested by including the widgets field in the properties query parameter.