What is it?

The new Reporting API allows you to programmatically create and manage dashboards, and search and manage existing reports. You can perform these actions directly through the API instead of completing them one at a time in the UI.

You can create, clone, search, update, archive, and restore dashboards, and search, update, archive, and restore the metadata of existing reports.

Why does it matter?

As the number of dashboards and reports you manage grows, updating them one at a time can take significant time and effort.

With the Reporting API, you can:

• - Bulk-update owners and permissions across hundreds of dashboards or reports at once
• - Clone an existing dashboard to quickly stand up a similar reporting setup
• - Automate dashboard provisioning for new teams
• - Export dashboards and reports to other HubSpot users programmatically

How does it work?

Send requests to the new Reporting API endpoints to create, search, update, archive, or restore dashboards, and to search, update, archive, or restore report metadata. Batch endpoints are available for updating owners and permissions across multiple dashboards or reports at once.

Export endpoints require an app with user-level access. Apps with account-level access, including legacy apps, cannot call export endpoints.

Report creation is not available in this initial version, since a report cannot be created without its configuration. HubSpot is working toward a public report configuration format that will support this in the future.

For full details on supported endpoints and actions, see the developer documentation.

Who gets it?

Available to HubSpot Professional, Enterprise, and Credits customers.