Update report
Partially updates a report. All fields in the request are optional; only the fields which are present will be updated.
Can also be used to archive or restore a report using the archived field. When archived is present in a request, it must be the only field present, or it will result in an error. Archived reports are purged after 90 days.
Note that reports on any dashboards cannot have their permissions updated; they inherit the dashboards’ permissions. Attempting to update them will result in an error.
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 update.
Body
Whether to archive (true) or restore (false) the report. Cannot be combined with any other fields.
The new business unit ID to use for the report. Set to null to reset to the account's default business unit. Omit to leave unchanged.
"string"
The new description to use for the report. Set to null to clear the description. Omit to leave unchanged.
"string"
The new name to use for the report. Omit to leave unchanged.
The ID of the user to change the report's owner to. Omit to leave unchanged.
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.
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.
Only returned when requested by including the tags field in the properties query parameter.
The ID of the user who last updated the report. May be absent.