Embedding Dashboards and Widgets

This article is about getting started with embedded Sisense dashboards. If you’re new to Sisense, check out our embedded analytics solutions.

You can embed Sisense dashboards and widgets in non-Sisense environments, such as in your own websites or applications by concatenating parameters to the URL of your dashboard or widget.

In addition, you can customize what aspects of the dashboard and widget are displayed in your environment.

For example, if you want to remove the Sisense header from the dashboard, you can concatenate the “?embed=true&h=false” parameter in the URL of the dashboard to hide the header.

mysite.com/app/main#/dashboards/5541dc7a80a4e2181e00011a?embed=true&h=false

In this example, the “embed=true” embeds the dashboard into your environment. When you embed a dashboard or widget, viewers can only view the dashboard or widget and do not have any editing privileges. The “h=false” parameter hides the Sisense header allowing you to whitelabel the dashboard.

This article provides a full list of the parameters you can concatenate, their functionality, and examples.

Embedding Dashboards

To embed a dashboard, add “?embed=true” to the URL of the dashboard, and refresh the page. If your dashboard is within a folder, then first delete “?folder=” and everything that follows, before adding “?embed=true”.

This will open the dashboard without the surrounding Sisense environment.

For example:

Dashboard URL:

mysite.com/app/main#/dashboards/5541dc7a80a4e2181e00011a

Embedded URL:

mysite.com/app/main#/dashboards/5541dc7a80a4e2181e00011a?embed=true

Dashboard URL for dashboard within folder:

mysite.com/app/main#/dashboards/550952417404b2981a000029?folder=550955a27404b2981a00003b

Embedded URL for dashboard within folder:

http://localhost:8081/app/main#/dashboards/550952417404b2981a000029?embed=true

You can use this URL to embed the dashboard in an iframe, for example:

Dashboard Embedding Configuration Options

You can control which aspects of the Sisense environment are available when embedding by concatenating the following parameters to the embedded URL:

Show/Hide the left Navigation Panel

Parameter: "l" (left) or "i" to hide it completely

Default: false

Example: ?embed=true&l=true

Show/Hide the right filter panel

Parameter: “r” (right)

Default: true

Example: ?embed=true&r=false

Show/Hide the toolbar

Parameter: “t” (toolbar)

Default: false

Example: ?embed=true&t=true

Show/Hide the environment header

Parameter: “h” (header)

Default: false

Example: ?embed=true&h=true

Embedding Widgets

To embed a single widget, add “?embed=true” to the URL of the widget when it edit mode.

This will open the widget without the surrounding Sisense environment.

For example:

Dashboard URL: http://mysite.com/app/main#/dashboards/536f3a54d093e26c28000114/widgets/536f3a54d093e26c2800011b

Embedded URL: http://mysite.com/app/main#/dashboards/536f3a54d093e26c28000114/widgets/536f3a54d093e26c2800011b?embed=true

You can use this URL to embed the widget in and iframe, for example:

Widget Embedding Configuration Options

You can control which aspects of the Sisense environment are available when embedding by concatenating the following parameters to the embedded URL:

Show/Hide the left data panel

Parameter: “l” (left)

Default: false

Example: ?embed=true&l=true

Show/Hide the right design panel

Parameter: “r” (right)

Default: false

Example: ?embed=true&r=false

Show/Hide the toolbar

Parameter: “t” (toolbar)

Default: false

Example: ?embed=true&t=true

Show/Hide the environment header

Parameter: “h” (header)

Default: false

Example: ?embed=true&h=true

Authentication in Embedded Dashboards and Widgets

All Sisense dashboards and widgets require authentication. When embedding dashboards and widgets outside of the Sisense environment, usually the use case is to not enforce the Sisense environment authentication, but rather use SSO (Single Sign On) with existing corporate authentication. To read more on configuring Single Sign On in Sisense, click here.