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

Sigma’s public embedding feature will allow you to display your interactive dashboards and visualizations in 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.

Public 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

Requirements
Who Can See my Data?
Create a Public Embed
Delete a Public Embed
Related Resources

Requirements

Who Can See my Data?

Public embeds are available to anyone with the embed url. Embed viewers will be able to input values into any controls you make visible on the dashboard.

Access to a public embed will not allow anyone to access additional data in Sigma without a Sigma account for your organization and proper permissions on the dashboard.

Create a Public Embed

To create a public 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 using an iframe.

The following instructions apply to both full dashboard and single visualization embedding.

  1. Open the dashboard in Sigma. 
  2. If the dashboard is in Edit mode, click the Publish button. A dashboard must be published to create or manage embeds.
  3. Click the vertical ••• menu icon in the Dashboard header.
  4. Select Embed Options from the menu to open the Embed Dashboard modal.
  5. This modal displays all available public and application embeds. By default, it opens to the Public embed tab.
    Screen_Shot_2020-08-26_at_9.53.54_AM.png
  6. Under Generate Public URL for select ‘Entire Dashboard’ or the single visualization you would like to create an embed for.
    Screen_Shot_2020-08-11_at_2.39.12_PM.png

  7. A public link and the embed code will automatically be generated.
    The embed code is an iframe html element with its ‘src’ property set to the public link set.
    Screen_Shot_2020-08-11_at_2.40.43_PM.png
  8. Click Copy to copy the embed code.
  9. Paste the <iframe> in your external application’s html codebase.

Delete a Public Embed

  1. Open the dashboard in Sigma. 
  2. If the dashboard is in  Edit mode, click the Publish button. A dashboard must be published to create or manage embeds.
  3. Click the vertical ••• menu icon in the dashboard header.
  4. Select Embed Options from the menu to open the Embed Dashboard modal.
  5. This modal displays all available public and application embeds. By default, it opens to the Public embed tab.
    Screen_Shot_2020-08-11_at_2.40.43_PM.png
  6. Click the trash can icon at the top right of the embed you would like to delete.
  7. If you have done so already, delete the embed code from your non-Sigma application.

Related Resources

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

 

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