Sign in
Dashboards

Export dashboard

Changed on

Exports a dashboard's content to one or more HubSpot users via standard HubSpot communication channels (notably, email).

Status tracking is not available; a successful request will result in a 204 No Content response.

Any set of HubSpot users can be specified as the recipients. However, if a given user does not have access to reporting, does not have CRM export permissions, etc., then they will receive a notification with an error rather than a successful export.

NOTE: This API can only be called from apps with user-level access. Attempting to call from an app with account-level access (including legacy apps) will fail, because only real users can request exports.

post/analytics/reporting/2027-03-beta/dashboards/{dashboardId}/export

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards/{dashboardId}/export
  • 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.read)
    • 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)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.hubsql.execute)

Path parameters

dashboardIdinteger required

The ID of the dashboard to export.

Request body

exportType'CSV' | 'PDF' | 'PPTX' | 'SCREENSHOT' | 'XLS' | 'XLSX' | 'ZIP' required

The type of export to perform. Valid values are:

  • SCREENSHOT: Individual report screenshots.
  • PDF: PDF with individual report screenshots.
  • PPTX PPTX with individual report screenshots.
  • ZIP: ZIP of individual report screenshots.
  • CSV: ZIP with one or more CSV files per report.
  • XLS: ZIP with one or more XLS files per report.
  • `XLSX: ZIP with one or more XLSX files per report.
messagestring

The message to include with the export. Optional, empty by default.

recipientUserIdsstring[]

Array of user IDs to send the export to. If absent or empty, the requesting user is used as the sole recipient; otherwise, this exact set of users is used.

reportIdsstring[]

Array of IDs of reports to optionally narrow the export to. IDs of reports that are not on the dashboard are ignored. If absent or empty, all reports on the dashboard are included.

subjectstring

The subject line to use for the export. If absent, the name of the requested report will be used. Max length of 100 characters.

Response

No content

Changes

  • 2027-03-beta2d237e903dfcRevision changes
    • ○

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

    • ○

      the security scope crm.hubsql.execute was removed from the endpoint's security scheme oauth2

  • 2027-03-betaae16703bd7c6Revision changes
    • ○

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

    • ○

      the security scope crm.hubsql.execute was removed from the endpoint's security scheme oauth2