Sharing and Embedding Dashboards

The application makes it easy to share your dashboards. Just click the Publish button on the upper right of the dashboard editor. Any logged-in member of your organization with adequate permissions can see your dashboard once it has been published. You can also share published dashboards with external users by clicking the share icon in the upper-right. A modal appears where you can generate a secret link to share safely outside your organization. External users can see the dashboard widgets but will not be able to navigate within the application or view the underlying queries.

You can revoke access to a dashboard for external users by toggling Allow public access. This will break any links to this dashboard that were shared previously. If you toggle the switch again a new secret link will be generated.

Admins can globally disable all public URLs by setting the environment variable REDASH_DISABLE_PUBLIC_URLS to "true".

1. Dashboard Permissions

A logged-in user will only see dashboard widgets derived from data sources to which the user has access. Users who can view a dashboard widget can also view the underlying query. Should you need to share a dashboard within your organization while also restricting access to the underlying data source, there are two options:

  1. Give your restricted users access using the secret link method described above

  2. Create a custom data source for the restricted employees and configure permissions at the database level

You can read more about permissions model here.

2. Embedding Dashboards

Some users embed their dashboards outside of the application using iframes. The application provides a Full Screen view to improve this experience. Full screen mode removes everything but the widget UI. Just click the full screen button to the right of the Refresh button. Then copy the URL from your browser into your iframe embed code. Embedding a dashboard in this way will require users to be logged-in to the application. To embed the application for external users you can use the secret link method described above. Secret links to the application dashboards are full screen by default.

An embedded dashboard may use parameters. But any user can modify dashboards, which makes the application the wrong tool for embedded analytics. Only share dashboards with trusted stakeholders.

Last updated