Sign in
Dashboards

Batch restore dashboards

Changed on

Restores one or more archived dashboards. Already-active dashboards are silently ignored. The maximum batch size is 500.

If any of the requested items fail, the response code will be 207 Multi-Status and the response will include details of individual failures.

post/analytics/reporting/2027-03-beta/dashboards/batch/restore

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards/batch/restore
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: reporting.full.write)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: reporting.full.admin)

Request body

inputsstring[] required

Array of report or dashboard IDs.

Response

successful operation

completedAtstring date-time required

The date and time when the batch operation was completed, in ISO 8601 format.

linksobject

A map of link names to associated URIs, providing additional information related to the batch operation.

requestedAtstring date-time

The date and time when the batch operation was requested, in ISO 8601 format.

startedAtstring date-time required

The date and time when the batch operation started, in ISO 8601 format.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.

Changes

  • 2027-03-beta2d237e903dfcRevision changes
    • ○

      the security scope reporting.full.write was added to the endpoint's security scheme oauth2

    • ○

      the security scope reporting.full.admin was removed from the endpoint's security scheme oauth2

  • 2027-03-betaae16703bd7c6Revision changes
    • ○

      the security scope reporting.full.write was added to the endpoint's security scheme oauth2

    • ○

      the security scope reporting.full.admin was removed from the endpoint's security scheme oauth2

    • ○

      added the optional property ///// to the response with the status

    • ○

      added the optional property ///// to the response with the status