Get report
Retrieves a single report.
Also supports retrieving archived reports via the archived query parameter. Retrieving archived reports requires the requesting user to be the report 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 report to retrieve.
Query Parameters
Whether to retrieve an archived dashboard instead of an active one. Default false.
Additional properties to include in the response. Valid values are: dashboardIds, permissions, tags.
Response
successful operation
Whether the report is archived.
The ID of the business unit that the report is associated with.
The date and time when the report was created, in ISO 8601 format.
The ID of the report.
The name of the report.
The date and time when the report was last updated, in ISO 8601 format.
If the report is archived, the date and time when the report was archived, in ISO 8601 format. Absent if the report is not archived.
The ID of the user who created the report. May be absent.
Array of IDs of the dashboards that this report is on.
For GET endpoints, only returned when requested by including the dashboardIds field in the properties query parameter. For other endpoints, not returned.
A description of the report. May be absent.
The date and time when the report was last viewed, in ISO 8601 format. Absent if it has not been viewed yet.
The ID of the user who last viewed the report. Absent if it has not been viewed yet.
The ID of the user who owns the report. Absent if the report is currently unowned.
Array of objects representing the tags that the report is tagged with.
For GET endpoints, only returned when requested by including the tags field in the properties query parameter. For other endpoints, returned when applicable.
The ID of the user who last updated the report. May be absent.