Dashboards¶

On this page

Dashboards Page

Create a New Dashboard
Sample Dashboard
Refresh Dashboard Data
Get Chart Data
Export and Import a Dashboard
Fullscreen Dashboard View

Dashboards are a collection of charts assembled to create a single unified display of your data. Each chart shows data from a single MongoDB collection or view, so dashboards are essential to attain insight into multiple focal points of your data in a single display. Dashboards can be shared with other users.

Dashboards Page¶

The Dashboards page shows all dashboards you have access to view. To learn more about dashboard permissions in MongoDB Charts, see Dashboard Permissions.

Each dashboard shows the following information:

Title
Description
A preview of the first three charts in the dashboard, including the chart title and type
When the dashboard was last modified

By default, the most recently modified dashboards are shown first in the list. You can change the sort order by using the Sort By dropdown menu.

Create a New Dashboard¶

To create a new dashboard:

From the Dashboards page, click the Add Dashboard button.
In the Add Dashboard dialog, enter a title for your dashboard.
(Optional) Enter a description for your dashboard.
Click Create.

After after clicking the Create button you are taken to the page for your newly created dashboard, where you are prompted to add the first chart to your dashboard:

Sample Dashboard¶

MongoDB Charts provides a Sample Dashboard that uses movie data to show examples of possible charts you can create. You can access the Sample Dashboard by going through the Charts Welcome Experience, or adding it through the Charts Settings page.

Note

If you remove the Sample Dashboard, you can add it back through your Charts Settings page.

Sample Dashboard Filters¶

The Sample Dashboard comes with default filters for Genres and Year of Release. You can adjust these filters to modify the data that appears on your dashboard. To learn more about filtering dashboard data, see Filter Dashboards by Field Values.

Refresh Dashboard Data¶

MongoDB Charts automatically refreshes chart data once it becomes out of date with the backing data source. You can also manually refresh dashboard data at any time.

To learn how to configure auto refresh settings and underlying refresh behavior, see Refresh Dashboard Data.

Get Chart Data¶

Authenticated dashboard users can view and export the underlying chart data as a table. To view the chart data, click Get Chart Data from the menu. Each row in the table represents a data point.

Note

Users who open a dashboard using a public link can't get chart data.

Important

Data Table Differs from Chart Visualization

Some configuration options you see reflected on a chart visualization are not applied to the data table. The Chart Data table displays underlying data retrieved with your full aggregation pipeline, and not all Chart Builder configuration options apply aggregation stages. Review your data to verify its contents.

If you want to analyze your underlying data with a third-party tool, you can download your data from the Chart Data modal. To download your data, click Download - CSV or Download - JSON.

Viewing chart data will display a table of the values used to create a chart. It also allows for downloading a CSV or JSON representation of that table.

Export and Import a Dashboard¶

You can export a dashboard to a file, which you can then import. Use this feature to:

Store your dashboard outside of MongoDB Charts
Import exported charts into the same or a different project

Export a Dashboard to a File¶

You can export a dashboard to a single file named <Dashboard-Title>.charts. The file contains the metadata for the dashboard, including:

Dashboard name and description
Dashboard layout including location of the charts in the dashboard
Chart definitions
Dashboard filter definitions
Details of the data sources used on the charts including:
- Cluster name
- Database name
- Collection name
Embedding settings for each chart including:
- Whether each embedding type is enabled or disabled
- Filter allow list
- Injected filter code

The file doesn't include:

Dashboard permissions
External sharing settings for the data sources used
Data source pipelines
Chart embedding IDs

You must have Viewer or higher permissions to export a dashboard.

You can export a dashboard from the Dashboards page or from the dashboard itself. To export a dashboard:

If you are on the Dashboards page, click the ellipsis (...) for the dashboard you want to export.
If you are on a dashboard, click the ellipsis (...) in the top right corner.
Follow the browser prompts to download the file.

Import a Dashboard From a File¶

You can import a dashboard from a file on the Dashboards page. The file to import:

Can't be larger than 16 MBs
Must be a valid .charts file that you downloaded from a dashboard

From the Dashboards page:

Click the Add Dashboard dropdown and select Import Dashboard to display the Import Dashboard modal.
Drag and drop the file to import or click Choose File and select the file to import.
Click Next.

Select the data source for the dashboard from the Data source at destination dropdown.

The Import Dashboard modal displays a list of all the data sources used by the file being imported under Data source in file column. For each data source in the file, select a Data source at destination:

Option	Description
<Mapped Data Source>	Option to select any data source in your project. The data source you select is used instead of the Data source in file for charts imported in to the dashboard.
Connect later	Option to choose the data source to use later. MongoDB Charts imports all charts using the Data source in file, but no data source is selected. The charts don't render until you edit each chart and choose a new data source.
Exclude charts using this data source	Option to exclude charts that use the Data source in file. Charts that use the Data source in file won't be imported.

If MongoDB Charts detects that a data source in your project is the same as the data source in the file, that data source is selected by default. Otherwise, Connect later is selected by default.

Important

Imported charts may not render properly if mapped to a data source that the chart wasn't built to use.

Click one of these buttons:
- Save to import the dashboard.
- Save and Import Another to import this dashboard and import another dashboard from a file.
- Cancel to exit the modal without importing the dashboard.

Fullscreen Dashboard View¶

MongoDB Charts provides a fullscreen view for dashboards. In this view, MongoDB Charts hides the main navigation bar and expands the dashboard to show the title, description, time of last modification, and charts in the entire space of the screen.

To enter the fullscreen view for dashboards:

Select a dashboard from the Dashboards page.
Click the expanding arrows at the top-right of the dashboard.

Note

In the fullscreen view for dashboards, you can still:

Remove, resize, rearrange, and edit charts by hovering over the desired chart.
Configure auto-refresh settings and manually refresh chart data.
Enter the fullscreen charts view.

To exit the fullscreen view for dashboards, do one of the following tasks:

Click the contracting arrows at the top-right of the dashboard.
Press the escape key.

← Arrange the Charts on the Dashboard Manage Existing Dashboards →