Sign in
Dashboards

Create dashboard

Changed on

Creates a new dashboard. Existing reports can optionally be attached to the dashboard at creation time; report widgets will be appended sequentially.

Attaching reports to the dashboard is done on a best-effort basis, and it's possible that some or all reports may fail to be attached. The dashboard will still be created, and no error will be returned. The requestor should check the widgets field in the response object to see which reports were successfully attached.

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

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/analytics/reporting/2027-03-beta/dashboards
  • 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

businessUnitIdstring

The ID of the business unit to associate the new dashboard with. Optional, the account's default is used by default.

descriptionstring

A description of the new dashboard. Optional.

namestring required

The name of the new dashboard.

reportIdsToAddstring[]

Array of IDs of reports that should be added to the dashboard after creation. Optional.

Response

successful operation

archivedboolean required

Whether the dashboard is archived.

archivedAtstring date-time

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.

businessUnitIdstring required

The ID of the business unit that the dashboard is associated with.

createdAtstring date-time required

The date and time when the dashboard was created, in ISO 8601 format.

createdByUserIdstring

The ID of the user who created the dashboard. May be absent.

descriptionstring

A description of the dashboard. May be absent.

idstring required

The ID of the dashboard.

lastViewedAtstring date-time

The date and time when the dashboard was last viewed, in ISO 8601 format. Absent if it has not been viewed yet.

lastViewedByUserIdstring

The ID of the user who last viewed the dashboard. Absent if it has not been viewed yet.

namestring required

The name of the dashboard.

ownerUserIdstring

The ID of the user who owns the dashboard. Absent if the dashboard is currently unowned.

updatedAtstring date-time required

The date and time when the dashboard was last updated, in ISO 8601 format.

updatedByUserIdstring

The ID of the user who last updated the dashboard. May be absent.

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