Private Embedding (Dashboards)

IMPORTANT: This document is specific to Sigma dashboards. To learn about this topic for Sigma’s new Workbooks feature, please visit Private Embedding (Workbooks).

Sigma’s private embedding feature will allow you to display your dashboards and dashboard visualizations in other applications. Your embedded data will update in real time with Sigma, as it responds to new data from your warehouse. A person must be logged in to Sigma to view a private embed.

Private embedding is one of three embedding options. To learn more about embedding in general and explore all three options, visit Dashboard Embedding: An Overview.

Summary of Content

Who Can See my Data?
Creating a Private Embed
      Creating a Full Dashboard Embed
      Creating a Single Visualization Embed
Deleting a Private Embed
Related Resources

Who Can See my Data?

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.

Creating a Private Embed

To create a private embed, you will need to create a private embed URL, and you or someone on your team will need to know how to inject the embed into your non-Sigma application using an iframe.

Creating a Full Dashboard Embed

  1. Open the dashboard in Sigma. 
  2. If the workbook is in a draft state, click the Publish button. A dashboard must be published to create an embed URL.
  3. Copy your published dashboard’s URL and add `?:embed=true`. The embed URL should look like this:
    https://app.sigmacomputing.io/<your-organization-url>/db/<dashboard-id>?:embed=true
  4. In your non-Sigma application, add an <iframe> element in the html code with the “src” property set to the embed link.
    <iframe src="https://app.sigmacomputing.io/<your-organization-url>/db/<dashboard-id>?:embed=true" />


Creating a Single Visualization Embed

  1. Open the dashboard in Sigma that contains the visualization that would like to embed. 
  2. If the workbook is in a draft state, click the Publish button. A dashboard must be published to create an embed URL.
  3. Hover over the visualization you would like to embed, and click on the ‘Maximize Visualization’ button.
    Screen_Shot_2020-08-12_at_11.08.30_AM.png

  4. With the visualization maximized, copy your published dashboard’s URL, and add `?:embed=true`. The embed URL should look like this:
    https://app.sigmacomputing.io/<your-organization-url>/db/<dashboard-id>?:embed=true&:expanded=<visualization-id>
  5. In your non-Sigma application, add an <iframe> element in the html code with the “src” property set to the embed URL.
    <iframe src="https://app.sigmacomputing.io/<your-organization-url>/db/<dashboard-id>?:embed=true&:expanded=<visualization-id" />

Deleting a Private Embed

Private embeds are created by adding ‘?:embed=true’ to the end of a published dashboard’s URL. As such, nothing needs to be changed in Sigma to delete a private embed. You can however, remove the embed from the non-Sigma application. And the embed will also be broken if the dashboard is deleted in Sigma.

Related Resources

Dashboard Embedding: An Overview
Dashboard Controls in Embeds
Public Embedding
Application Embedding

 

IMPORTANT: This document is specific to Sigma dashboards. To learn about this topic for Sigma’s new Workbooks feature, please visit Private Embedding (Workbooks).