Skip to main content

Sharing Links

Plan Restriction

Sharing links are not available on the Free plan (see Pricing).

Dashboard Sharing Links are an easy way to give access to a dashboard or a single report to anyone, even those who do not have an account on Cluvio. Such links are also the basis for embedded analytics. Depending on your Cluvio plan, a sharing link can have various restrictions.

Here is an example of a dashboard sharing link: https://dashboards.cluvio.com/dashboards/jvre-px0w-p1z2/shared?sharingToken=1c1d9827-bbd6-4d08-af81-2f68baacd81d

Below is the same dashboard sharing link used in an embedded iFrame:

You can manage dashboard sharing links by selecting Sharing Links & Embedding from the dashboard actions of the dashboard that you wish to share.

image-500 image-500

To create a new sharing link, use Add New or Add New (Current filters):

  • Add New: Creates a new sharing link that uses the dashboard filter default values. If the dashboard filter defaults change, the sharing link reflects these changes.
  • Add New (Current filters): Creates a new sharing link that uses the currently selected dashboard filter values. The sharing link will not be affected by changes to the dashboard filter defaults.

To open a sharing link in a new browser window or tab, select Show Link followed by Open Link below the displayed URL. To embed a link in another web page via an iframe, select Embed Code. An HTML fragment for an iframe will be shown that you can copy & paste into your web page at the desired place.

For more information and advanced embedding options, see Embedded Analytics.

Configuration​

A sharing link has many configuration options. To configure a link, select the pencil icon next to the sharing link that you wish to change. The configuration options for the selected link will open directly below the link.

image-500 image-500

The name of a link will be displayed in the page title in addition to the dashboard name. The following sections describe some of the configuration options in more detail.

IP Whitelisting​

In the IP Whitelist text input, you can enter one or more comma-separated IP addresses or use CIDR notation for entire subnets from which the link can be accessed. This is a great way to share dashboards within your company network while preventing access from outside the company network.

Password​

To set a password on a sharing link, select Set Password. You will be prompted to enter the password. Once a password is set, it is only revealed on-demand and can be changed at any time by an admin or analyst with access to the dashboard.

image-500 image-500

Any user who accesses the sharing link will be prompted to enter the password. When the password is changed, any user that accessed the dashboard with the old password will be prompted to enter the new password.

Expiration​

To set an expiration on a sharing link, select Set Expiration. You will be prompted to select the duration. Either choose one of the predefined durations or select Custom to specify an exact date & time of expiration in the organization's time zone.

image-200 image-200

Options​

The link options control the level of interactivity that the link allows.

  • Show Toolbar: Whether the toolbar at the top of the dashboard that shows the name, description and selected filter values should be displayed.

  • Allow CSV/Excel: Whether downloading of dashboard or report data as CSV or Excel should be allowed from the dashboard actions or report actions drop-down menus.

  • Allow Unlimited CSV: Whether downloading of "unlimited" CSV files of reports (up to a plan-specific maximum file size) should be allowed from the report actions drop-down menus.

  • Allow Parameters: Whether the sharing link allows URL parameters for the dashboard's filters and is thus interactive, either with or without a toolbar.

  • Interactive Toolbar: Whether the toolbar, if shown, is interactive. Requires Show Toolbar and Allow Parameters to be enabled. An interactive toolbar allows changing the dashboard's filters via the Cluvio toolbar just like for viewer users. To restrict the possible filter selections, Requires Secret must be enabled and a sharingSecret must be used to configure fixed / restricted parameter values. See Embedding for further details.

  • Requires Secret: Whether the link should require an additional sharingSecret parameter which must be a JSON Web Token authenticated with the organization secret. With the sharingSecret you can customize sharing links programmatically, such as limiting the allowed Cluvio filter parameters depending on the permissions of the user in your application, in a way that cannot be tampered with. See Embedding for further details.

Filters​

In the Filters section you can set or remove the use of the currently selected filter values on the link. The Filters section is only present if the dashboard has filters.

image-300 image-300

For example, if you previously created a link with the dashboard default values, you can later change the filters used by the link to the current selection via Set to Current. Conversely, if you want to revert a link to use the dashboard default filter values, select Remove.

Drill-Down​

Drill-down actions are configured on report charts and are used to create links to either the same dashboard or another dashboard with specific filters applied. Drill-down actions are a form of interactivity and thus are only enabled on a sharing link if Allow Parameters is enabled.

Only drill-down actions that target the same dashboard are enabled automatically on interactive sharing links. To enable drill-down actions targeting other dashboards on interactive sharing links, you need to explicitly configure the sharing link to allow access to the drill-down target dashboards. To do so, add the dashboards in the "Drill-Down Targets" section of the interactive sharing link configuration.

image-500 image-500

In order to enable drill-down actions on non-interactive links or for drill-downs on interactive sharing links targeting other dashboards without configuring allowed drill-down targets, the use of custom JavaScript in the context of an embedded dashboard is required. See Drill-Down for embedded dashboards.

URL Parameters​

The following URL parameters can be added to any sharing link for ad-hoc customization of the appearance of the linked dashboard or report. Typically, these parameters are used in the context of embedding:

  • tvMode<=true|false|fullscreen>: When set to true (or without a value), the height of the reports dynamically adjust to make the dashboard height fit the screen height. When set to fullscreen, the effect is only applied when the page is viewed fullscreen / maximized. When not present or set to false, the dashboard is displayed as usual, with the report heights honoring the dashboard layout configuration.

    image-800 image-800

    TV mode is ideal for dashboards displayed on a wall-mounted TV, making full use of the TV height / aspect ratio.

  • backgroundColor=<color>: Overrides the background color of the dashboard. The value can be any hex color value (without the leading # character). (Example Link)

  • noBorder=<true|false>: If set to true, the border of the individual report widgets will be hidden. Defaults to false. (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 configuration. (Example Link)

  • reportId=<id>: Specify a single report from the shared dashboard that is shown maximized. You can see the report IDs in the browser 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 UI, allowing to embed or share just a single report. (Example Link)

  • expandFilters[=true]: When present or set to true, the filter bar on top of the dashboard is automatically expanded so that viewers of the link do not need to click to reveal the filters. This setting has no effect on links that are not interactive. (Example Link)

  • 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 navigation between reports is faster. If set to false (or not present), only the specified report will be loaded, thus optimizing for the initial display experience. Defaults to false.

  • oneColumn=<true|false>: Whether to completely turn off the behavior of switching to single-column layout below a certain width of the browser window. (Example Link)

  • oneColumnMinWidth=<number>: 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. Defaults to 12. (Example Link)

  • hideLoadingIndicators=<true|false>: With this option set, the small loading indicators in the top-right corner of each report are not displayed. This is especially useful for embedded dashboards with 1 or 2 minute refresh rates, as these would result in the loading indicators being present most of the time on some reports, resulting in unnecessary visual noise.

Sharing Token​

Every sharing link contains a sharingToken URL parameter which is a random UUID based on a cryptographically secure random number generator. This token uniquely identifies the link in Cluvio. While a sharing token cannot be guessed, anyone who obtains a sharing link has access to the information on the shared dashboard or report.

Additional Security​

To ensure the confidentiality of your sharing links, only share links with authorized users and for sensitive data use secure channels for distribution of links, like secure messaging applications with end-to-end encryption and device authentication. To further secure access to sharing links:

  • Use Cluvio's IP whitelisting to restrict access to links from within a secure corporate network.
  • Set strong passwords on your sharing links which are shared with the intended recipients on a separate, secure communication channel.
  • Set an expiration on your sharing links to automatically revoke access after a selected duration.
  • Delete links that should no longer be used.
  • For sharing links used for Embedding, generate short-lived sharingSecrets.