Summary of Content
- To generate public and application embeds, you must be an organization Admin.
- Any Sigma user can create a private embed.
Workbook embedding allows you to present your analysis outside of Sigma in a controlled and secure manner. 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 workbook or workbook page or data element. 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>/workbook/<workbook-id>" />
Embed URL creation varies depending on the embed type you are implementing.
Full Workbook vs Single Page vs Single Element Embeds
Public and Application embed types support both full workbook, workbook page, and individual data element embedding. Private embeds support full page embedding.
You can use the Workbook Embed modal, found in your workbook's header menu, to create any public and/or application embed. Private embeds are created by adding `?:embed=true` to the workbook's URL.
Workbook Controls in Embeds
Controls can be hidden from viewers. To hide one more controls, create a new hidden page in the workbook. Housing your controls here will hide them from anyone without Can Edit permission on the workbook. Learn more.
Controls in the Dashboard URL
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 workbook 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.
Types of Embedding
Public embeds are available to anyone with the embed URL. This may be a good option if you want to display your embed on a public facing website. Please be sure you only show the data you want others to see.
Access to a public embed will not allow someone to access your data deeper in Sigma without a Sigma account for your organization.
Learn more about Public Embedding.
Private embeds are only visible to your Sigma organization’s members with access granted on the workbook. 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.
Private embeds are only supported for full workbooks; you cannot use a private embed for a single workbook page or element.
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 data 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.