Sharing and Embedding

Sharing dashboards via link

Available on plans: Pro, Business, Enterprise

Sharing links are a great way to give secure access to a dashboard to anyone, even those who do not have a viewer account on Cluvio. It is also a cornerstone of the powerful Embedding capabilities.

Based on your Cluvio plan, the sharing link can have a specific set of filters applied, access can be restricted to a set of IP addresses to make sure no one outside your network can access it.

 

Creating sharing links

You can configure dashboard sharing for a dashboard by selecting Sharing Links from the dashboard dropdown menu.

 

Create_Sharing_Link.png

 

Here is a rundown of the options:

  • Name - give the link a descriptive name. This will be also displayed in the shared link page title (in addition to the dashboard name)
  • Description - an optional description, you can use this to capture the purpose of the link
  • IP Whitelist - optional set of IP addresses or CIDRs that restrict access to the link. This is a great way to share dashboards with everyone in your company but prevent people outside to have access
  • Dark Mode - specify if the sharing link should have a dark or light version of the dashboard. The Dark Mode can be especially useful if you want to put the dashboard up on a TV on wall
  • Show Toolbar - turns on or off the top bar of the dashboard that shows the name, description and the filter values
  • Allow CSV/Excel - allow or disallow the dashboard to offer the menu items to download its raw data as CSV or Excel
  • Requires Secret - further secure the sharing link via a JWT token that you need to generate. More details in the Embedding section
  • Allow Parameters - only available if Requires Secret is set to true, this will allow the dashboard to be interactive - i.e. render with different sets of parameters
  • Interactive Toolbar - if both Allow Parameters and Show Toolbar are set, this option will allow to render the dashboard as fully interactive (with the possibility to fix some of the filters - see Embedding for details)

Clicking on the Embed link will display a sample embed HTML snippet for the dashboard.

The history (under the clock icon) action shows a history of actions performed on the sharing link.

 

Advanced URL options

The following URL parameters allow you to further customize the Dashboard Sharing Link behavior:

backgroundColor Allows to specify the background color of the dashboard grid, simply replace XXXXXX with the hex value of the color. Do not prepend with '#'.  Example
noBorder true / false

- If noBorder is set to 'true', the border of the individual report widgets will be hidden.

 Example
darkMode true / false

- If darkMode is set to 'true', the dashboard will be displayed in dark mode, if 'false' in light mode - this allows to override the dark mode setting of the sharing link.

 Example
reportId

Allows to specify a single report from a dashboard that is shown maximized. You can see the report id as part of the URL if a report is edited.

 Example
reportOnly

In case reportId is set, specifying reportOnly would allow to disable the link back to the full dashboard in the top-right corner (i.e. truly embed/share just that single report).

 Example

Example (embedded)
preloadDashboard

 In case reportId is set, this parameter allows to control if the other reports on the dashboard should be preloaded. If set to true, the initial load might be longer, but subsequent switching of reports (via post-messages) will be immediately smooth. If set to false (or not present), only the specified report will be loaded, thus optimizing for the initial display experience.

 Example (preload)

Example (no preload)
oneColumn true / false

- Allows to completely turn off the behavior to switch to single-column layout below certain width.

 Example
oneColumnMinWidth

Allows to tune the number of pixels, below which the dashboard grid switches to the single column mode (default value is 768).

 Example
gridColumns

Number from 1 to 12 that defines how many columns the grid has.

  Example
hideLoadingIndicators

With this option set, the small loading indicators in top-right corner of each report are not displayed. 

Useful esp. for embeds of dashboards with 1 or 2 min refresh rate - these could show the loading indicators most of the time and result in a lot of visual noise.

  

 

A full example URL: 

https://dashboards.cluvio.com/dashboards/5j3y-dk5v-po92/shared?gridColumns=6&oneColumnMinWidth=400&noBorder=true&backgroundColor=DEF&sharingToken=92b95879-ccf1-4a32-aea0-7ca814078cb1

 

 

Related articles