Dashboards are the main hub of your Heap account, which is why they're the default page you land on when opening heap.io. They are used to organize relevant reports into the same space to review all of the analytics your team needs at a birds-eye view. You can create as many Dashboards as you need, and organize them into categories by team, feature, release, and more.

We recommend building out high-level dashboards that span multiple teams to get a summary of how the needles are moving, and build focused dashboards to understand the depth of an analysis.

Default Dashboard Settings

When you set up Heap for the first time, a set of core dashboards will be available by default. The reports in these dashboards provide metrics on attribution, engagement, conversion, and retention, user count, and more.

These reports utilize autocaptured properties and core events provided in your account by default when you install Heap. Use the Dashboards navigation drop-down in the image above to check out the different reports available for you to jumpstart your analysis.

Building a Dashboard

There are two ways to create a dashboard of your own. The first way is to click the '+ Create New Dashboard' button from within the Dashboards drop-down.

The second way to create a new Dashboard is to click the '+ Pin this report to a dashboard' button from the report pinning menu.

You'll be prompted to either select an existing report, or create a new one by clicking the '+ Create a new Dashboard' button.

On your new Dashboard, you'll see options to give your dashboard a name, categorize it, and toggle the visibility in your workspace. Click save and you're done!

Using Dashboards

Dashboards can have a maximum of 12 reports within them. They work with the same graph, funnel, users, retention, influence, and paths reports you have already built inside Heap.

Once you have several reports in a dashboard, you can drag the cards to rearrange things to your liking.

Dashboard queries are cached every 24 hours, so you can access your data quickly without waiting for even the most complicated queries to complete. If you need up-to-date data, you can always click the “refresh” button in the dashboard toolbar.

Within a dashboard, you can click the report title to be taken to the corresponding report and analysis module.

You can organize your dashboards using the same categories you use across your account to keep things neat and tidy. Dashboards can also be created, copied, and moved between Personal Spaces and shared spaces.

Home Dashboard

Admin or Architect Configuration Only

You must be an Admin or Architect to select a home dashboard for your Heap account. Please contact an Admin or Architect on your team if you'd like to change your home dashboard.

You can customize the view your team members are presented when they login by selecting a home dashboard. Home dashboards are configured on a per-project basis, and all users in the project will be shown the selected dashboard upon login. Heap will default users to the reports view in the absence of a selected home dashboard.

To set a home dashboard, all you need to do is visit a dashboard in your Heap project and click the home icon in the top-right of the dashboard. When selected, you'll be prompted to confirm the selection.

If you'd like to change the home dashboard, simply navigate to a different dashboard in your Heap project and repeat the process. If desired, you may also specify the reports view as the home location for all users by clicking the home icon in the reports view. You'll be prompted to confirm this selection.

Frequently Asked Questions

Why does my report say 'table visualizations are not supported' when listed in a dashboard?

This will appear if you pin a report that uses the table chart type. Simply update the report to a different chart type, then the report metrics will be visible on your dashboard.


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.