Dashboard Embedding: An Overview
Sigma’s dashboard embedding features allow you to embed your interactive dashboards and visualizations into other internal or external facing applications. Your embedded data will update in real time with Sigma, as it responds to new data from your warehouse.
As a Sigma admin, you have the option to use any of three embed types, depending on your specific use case. The following article will cover Sigma embedding basics and outline the three types of embeds: public, private, and application embedding.
Summary of Content
- Only Sigma Admins can generate public and application embeds. Learn more about account types.
- Any Sigma user can create a private embed.
Sigma’s Dashboard embedding features allow you to present your analytics outside of Sigma in a controlled and secure manner. You may choose to use this feature to expose your work either internally or externally. To create an embed, you will need to know how to create an embed URL, and you or someone on your team will need to know how to inject the embed into your non-Sigma application.
Iframes and Embed URLs
Iframes and embed URLs are key to displaying any embedded dashboard or visualization. An iframe is the type of html element that renders the embed in the browser. To tell the iframe what to render, you will need to pass it an embed URL.
<iframe src=”https://app.sigmacomputing.io/<your-organization-url>/db/<dashboard-id>” />
Embed URL creation varies depending on the embed type you are implementing.
Dashboard vs Single Visualization Embeds
All three embed types support both full dashboard and individual visualization embedding.
You can use the Dashboard Embed Modal, found in your dashboard’s header menu, to create any public and/or application embed.
Both dashboard and single visualization private embeds, on the other hand, are created by appending `?:embed=true` to the dashboard / visualization URL.
Dashboard Controls in Embeds
If your dashboard takes advantage of dashboard controls, you may want to consider how they can impact your embedded analytics.
Dashboard authors have the option to select whether a control is accessible by dashboard viewers. If a control is visible, it can be passed values by any dashboard viewer. This includes viewers of an embedded version of the dashboard.
If a control is hidden, an embedded dashboard’s viewers will not see the control or its value(s). And the only way they will be able to manipulate a hidden control’s input is through associated interactive charts or coordinated drill downs.
Controls in a Dashboard URL
Dashboard authors also have the option to select whether a control can receive viewer input via the dashboard URL. Like hidden controls, this option is selectable under control placement.
When you create a public or private embed, you may choose to include control values in the embed URL yourself. These can be added into the embed URL like any other dashboard URL. Learn more.
The creation process for application embeds is more complex. In these cases, initial control values should be injected into the url during the server-side url generation process. Learn more.
Types of Embedding
Public embeds are available to anyone with the embed url. This may be a good option if you want to display a dashboard or a visualization on a public facing website. Please be sure you only show the data you want others to see.
Private embeds are only visible to your Sigma organization’s members with access granted on the dashboard. An organization member must be logged into their Sigma account to view the embed. If they are not logged into Sigma, the embed will prompt them to sign in to their account.
This type of embedding may be useful for displaying your analytics in internal tools, like a company only portal a television in your workspace.
Learn more about Private Embedding.
Application embedding is a way to securely embed your dashboard or visualization without your users needing to authenticate through Sigma. This type of embedding is useful when you are embedding Sigma into your applications for your customers.
To create an application embed, you will use a Sigma embed secret, custom session times, and a server side generated embed URL.
Learn more about Application Embedding.