Orbit API
Creating custom dashboards
This guide will walk you through creating custom dashboards and saving figures into them within your Orbit workspace.
Overview
Custom dashboards allow Orbit users to save the Figures they’ve built (using the Reports Builder) inside of named Dashboards.
Dashboards can be either Shared or Personal. Shared dashboards are able to be viewed, edited, and deleted by other members in your Orbit workspace, while Personal dashboards are only accessible and modifiable by you.
Adding a new dashboard
📘 Shared dashboards are limited to three per workspace on our Starter plan and are unlimited on our Growth plan
To add a new custom dashboard, navigate to Reports, and select ‘New Dashboard’ in the ‘Custom Dashboards’ dropdown
Give the dashboard a name and choose a visibility option (either Shared or Personal). Click ‘Submit’ and then ‘Go to Dashboard.’
- Within the newly-created dashboard view, you’ll have the option to edit or delete the dashboard, as well as add a new figure to it.
Adding a new figure to your dashboard
📘 Each dashboard can contain a maximum of eight figures.
There are two ways to add a new figure to a dashboard: directly from the button in the dashboard, or from the Report Builder.
Adding a figure from the dashboard
Within your dashboard, click the button to 'Add a new figure' (if there are already figures in the dashboard, please scroll down to the bottom of the page to see the button).
From there, you'll be directed to the Builder, where you'll create your figure with your preferred parameters.
Give your figure a name, and click the 'Add to dashboard' button.
Adding a figure from the Builder
To add a figure from the Builder, navigate to "Reports" and click on "Builder" in the Reports navigation bar.
Within the Builder, create your figure with your preferred parameters. Once finished, click on ‘Add to dashboard.’
Within the modal that pops up, give your figure a name and choose from the dropdown menu the dashboard you’d like to add the figure to and click ‘Submit.’
Note: Dashboards that contain the maximum number of eight figures will be disabled as options in this dropdown dashboard selection.
Editing and deleting a figure from your dashboard
To edit or delete a figure in your dashboard, click on either 'Edit figure' or 'Delete figure' at the bottom right-hand corner of the figure.
For editing a figure, within the Builder, you'll be able to edit your figure’s parameters. Once completed, click ‘Update figure.’
For deleting a figure, once you confirm the deletion, your figure will be deleted (note: this cannot be undone).
