Sprinkle Docs

Dashboards V2

A dashboard is a group of cards neatly arranged on a grid, each card showing important data in charts and graphs. It's your one place for quick insights, helping you make informed decisions about your business or system with a single glance.
With Dashboards V2, we've made it simpler to add cards to dashboards, including Text Cards with Markdown Text. The experience and the design of the dashboards in Sprinkle have been upgraded. You can now effortlessly manage dashboard filters, and make use of the convenient saved filters feature.

Overview: New Dashboards V2

Dashboards V2 brings a host of new capabilities and enhancements to make your data visualization experience even more seamless and efficient. Here are the key highlights:
  • Easier journey to Add Reports: Creating your dashboard is now simpler and more intuitive than ever before. We've enhanced the user interface to provide a smoother experience when adding reports to your dashboard. With just a few clicks, you can quickly add cards to your dashboard.
  • Add Text Cards with Markdown Text: Communicate your insights effectively with the new text card feature. You can now include text cards within your dashboard, supporting Markdown text formatting. Craft informative narratives, provide context, and highlight key points right alongside your reports.
  • Easier Way to Add and Manage Filters: Adding filters on your dashboard to filter the data on the dashboard is now simpler. Easily add, edit, and remove filters to fine-tune your data views.
  • Separate View and Edit Modes: We've introduced view and edit modes for your dashboards. In the edit mode, you can make edits/adjustments to your dashboard layout and content, while the view mode provides a seamless and interactive experience for your audience. No more accidental changes while presenting your data!
  • Saved Filters in View Mode: Empower your users to create and save their filter states as saved filters. This means your audience can tailor the dashboard filters to their specific needs, saving time and improving their overall experience.

How to create a new Dashboard?

Let's get started with creating a new Dashboard on the new Dashboards V2.
Navigate to the Analyze -> Dashboards (New) from the left navigation. On the right corner of the listing page, you will find the button "+Create Dashboard". Click on the button to create your dashboard.
Provide a name to your dashboard. When done you are taken to your dashboard with an empty canvas in the edit mode, where you can add your cards.

Understanding the layout

On Dashboards V2, we have separate modes for editing and viewing the Dashboard. Let's first understand the Edit mode, where you would be setting up your dashboards for your audience.
On top of the interface, there is the Top bar which has a breadcrumb for navigation, buttons, and more.
Top Bar:
Refresh: In order to run the dashboard and get the updated result click on Refresh.
Mode Button: to switch to view mode from the Edit Mode and vice-versa.
Add: It's a dropdown button, that enables you to add cards/widgets to the dashboard. Add Report, enables you to add tabs from Reports you have created. Add Text, enables you to add a text card to your dashboard.
Note: Tabs from reports created on new Reports V2, can only be added to Dashboard V2.
Below the Top bar, the area is used to display the filters. The "+Add Filter" lets you add filters to your dashboard.
The major part of the screen is the dashboard canvas, where your added cards appear.
Edit Layout: It lets you adjust the size of each of your cards and enables you to be in control of how you want your cards to appear on the grid.

Add Report to Dashboard

Click/hover over the Add button on the top-right corner. Select - Add Report
Select the Report from which you want to add tabs for your analysis.
Select Tabs, is a multiple-select dropdown. You may add one or more tabs from your selected report to the dashboard.
You may also add tabs of your analysis from the Reports V2 itself. Click on the Add to Dashboard button on top. Select the dashboard onto which you want to add and the tabs you want to add.

Add Text Card to Dashboard

In Dashboards V2, we have introduced the feature to add text cards to provide context to your dashboards. Communicate your insights effectively with the new text card feature.
You can now include text cards within your dashboard, supporting Markdown text formatting.
Learn more about the markdown syntax here.
To add a text card, click on the Add Text option from the Add button on the top right.
Provide the title to your text card. By default the text editor is in view mode. You may include markdown formatting to your text and view it in the preview mode on the Add Text modal.

Filtering your Dashboard

The journey to add filters to your dashboard has been unified, where you may add filters of a Basic kind or variables, that you may have used in your scripts.
Click on the Add Filter button from the filter section.
Understanding various fields in the Add Filter Modal:


  • Label: Give a name to your filter, this would appear on your dashboard.
  • Type: Select between the Basic filter and Variables option. Basic Filters are those where you may link various columns used in the tables from which you have built the cards. Filter type of Variable type, lets you map the variables used in your cards to the filter on the dashboard.
  • Data Type: Choose from the following types. Numeric, Text, Date, True/False (Boolean). Selecting this helps you limit the option accordingly for the columns or variables of similar types at the card (report level). Read about Variables in Reports V2 here.

Update Cards

Here you can configure, which cards listen to the dashboard filter that you are setting up. Once you enable a card, you need to select the column in the table to which you want to link the filter to.

Filter - Interaction

Set up how the dashboard's audience interacts with the filter.
Input Method:
  • Type-in: Users need to type in the values to the filter
  • Pick-List: Users can select from the list of values. The picklist can come from the suggested values - unique values in the connected columns or the custom list.
  • Both: Users can type in the values or can search and select. The picklist can come from the suggested values - unique values in the connected columns or the custom list.
Show Relevant Values:
  • Not Applicable: When Type - Variable. It is dependent on linked columns
  • Show the relevant values in the suggested list of filter values. All the filters that are placed left of the current filter, filter out the options shown in the filter configured with show relevant values enabled.
Restrict Operators: It enables you to restrict certain operators for your filter Your audience will not be shown the restricted operators in the filters.

Filter - Default State

Each filter configured needs to have a default state. It is the state of the filter that appears upon loading the dashboard. Viewers can change this state as needed.

Saved Filters

Your audience can create and save their filter states as saved filters for the filters on the dashboard. This would enable them to quickly consume what is relevant to them.
This feature is available only in view mode and the saved filters are specific to the user.
To add or use Saved Filters, click on the Saved Filters button in the FIlters section. It has 3 options.
Save Filter: It saves the current state of the dashboard filter for the user. You may provide a name to your saved filter. For eg: You are a sales manager in Karnataka and would want to quickly see sales data for it. Just create a saved filter for yourself by putting the filter value to the state filter in the dashboard as Karnataka.
My Saved Filters: This shows the list of filters saved by the user. Click on the filter and hit apply to apply the selected filter to your dashboard.
Reset to Default: Refreshes the dashboard according to the default set filter state.

Embed your dashboard

You may embed your dashboard into websites or applications.
Click on the secure embed from the ellipsis (more options) on the top-right. On the modal, enable the embed by clicking on the toggle.
Copy the URL provided, and replace the API Key and secret in the URL. You may use your Key and secret from the accounts section, or utilize the user key upload feature to control who consumes your embeded dashboard on your application.