Note: Available on Pro, Business and Enterprise plans.
Links are an easy way to give access to a dashboard or a single report to anyone, even those who do not have a viewer account on Cluvio. Such links are also the basis for embedded analytics. Depending on your Cluvio plan, a shared link can have various restrictions.
Managing Links
You can manage dashboard sharing links by selecting Sharing Links & Embedding from the dashboard drop-down menu. The following dialog appears, where you can edit or remove existing links as well as create new links.
A new link can be created either with the current filters (i.e. selected values for the dashboard's query parameters) or defer to the defaults. For any link, the configuration options are the following:
- Name: A descriptive name that will be displayed in the page title in addition to the dashboard name.
- Description: An optional description.
- IP Whitelist: An optional set of IP addresses or CIDRs from which the link can be accessed. This is a great way to share dashboards with everyone in your company while preventing access by other people.
- Dark Mode: Whether the link should show a dark or light version of the dashboard. The dark mode can be especially useful if you want to put the dashboard on a TV on a wall.
- Show Toolbar: Whether the bar at the top of the dashboard that shows the name, description and active query parameter values should be displayed.
- Allow CSV/Excel: Whether downloading of the raw data as in CSV or Excel format should be allowed.
- Requires Secret (Embedding): Whether the link should require an authenticated JSON Web Token for access. The JWT must be authenticated with the account secret from your organization settings. See Embedding for further details.
- Allow Parameters: If Requires Secret is set, Allow Parameters controls whether the link should be permitted to include URL parameters for the dashboard's query parameters, thereby influencing what is shown on the dashboard.
- Interactive Toolbar: If all of Show Toolbar, Requires Secret and Allow Parameters are set, this option appears. If enabled, the dashboard is rendered fully interactive, with the exception of possibly some fixed parameters. See Embedding for further details.
- Filters: The values for the dashboard's query parameters, i.e. aggregations and filters, to associate with the link. These can either be Set to Current, thus fixing the link to the current values, or Removed if present. If not set, the dashboard's defaults at the time the link is used apply.
For a particular link, Share Link opens the link in a new browser window or tab, while Embed will display an HTML snippet for embedding the linked dashboard:
Notably, any link contains a sharingToken URL parameter which uniquely identifies the link.
Further URL Parameters
The following URL parameters can be added to any link for ad-hoc customization of the appearance of the linked content. Typically, these are used with links for embedding:
backgroundColor=<color> |
The background color of the dashboard grid. Simply replace <color> with the hex value of the color. Do not prepend with '#'. | Example Link |
noBorder=<true|false> |
If set to true, the border of the individual report widgets will be hidden. | Example Link |
darkMode=<true|false|auto> |
If set to true, the dashboard will be displayed in dark mode, if set to auto, the mode will depend on the operating system setting. This parameter overrides the dark mode setting of the sharing link definition. | Example Link |
reportId=<id> |
Allows to specify a single report from a dashboard that is shown maximized. You can see the report ID as part of the URL when editing a report. |
Example Link |
reportOnly=<true|false> |
If a reportId is set, reportOnly disables the link back to the full dashboard in the top-right corner of the UI, allowing to embed or share just a single report. |
|
preloadDashboard=<true|false> |
If a reportId is set, preloadDashboard controls if the other reports on the dashboard should be preloaded. If set to true, the initial load might be longer, while subsequent switching of reports is faster. If set to false (or not present), only the specified report will be loaded, thus optimizing for the initial display experience. |
|
oneColumn=<true|false> |
Whether to completely turn off the behavior of switching to single-column layout below a certain width. | Example Link |
oneColumnMinWidth=<number> |
Allows to tune the number of pixels below which the dashboard grid switches to the single column mode (the default is 768). |
Example Link |
gridColumns=<number> |
A number between 1 and 12 (inclusive) that defines how many columns the grid has. |
Example Link |
hideLoadingIndicators=<true|false> |
With this option set, the small loading indicators in the top-right corner of each report are not displayed. Useful esp. for embedding dashboards with 1 or 2 min refresh rates, as these would show the loading indicators most of the time, resulting in unnecessary 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