- 08 Sep 2023
- 1 Minute to read
Step 1: Preparation
- Updated on 08 Sep 2023
- 1 Minute to read
This article explains how to collect the required information to embed a dashboard into an application. To do this, access the Workspace and navigate to the dashboard, then select the Embed Dashboard option in the options menu. Enter one or more domains in which the dashboard will be embedded and enable embedding. This will display a dialog containing all necessary information such as Embedded Dashboard ID, Superset Domain, Workspace ID, Team ID and Embedded Dashboard ID which are used with Preset SDK or generate a new embedded guest token.
Before embedding any dashboard, the first step is to collect required information needed for Step 2: Deployment. This articles discusses how to retrieve the required information to properly embed a dashboard into your application.
Collect the information
What permissions is required to embed a dashboard?
The following steps require Workspace Admin role.
Access your Workspace, and navigate to the dashboard that you want to embed. Select the options menu icon (horizontal ellipsis) and choose Embed dashboard.
The Embed dialog appears. In the Allowed Domains field, enter one or more domains in which the dashboard will be embedded to (your application URL). Make sure to also include the domain for any development environment (separate multiple values with a comma).
- If adding domains, make sure to include the protocol (https or http).
- Leave the Allowed Domains field empty to allow embedding the dahsboard into any destination.
When done, select Enable Embedding. A dialog containing all required information to configure the integration in your application is displayed:
- The Embedded Dashboard ID and Superset Domain are used with the Preset SDK to embed the dashboard in your application.
- The Workspace ID, Team ID and Embedded Dashboard ID are used to generate a new embedded guest token.
The Embed dashboard option in the dashboard ellipsis menu can be used to launch this dialog at any time, to modify allowed domains settings, validate the information or even disable embedded.
Proceed to Step 2: Deployment.