Public Embedding

Public embedding allows you to display your workbooks and data elements 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 understand embedding in general and explore all three options, see Workbook Embedding: An Overview.

Summary of Content

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

Requirements

  • Only organization admins can generate public embed links; see Account types.

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 workbook.

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 workbook.

Export functionality in public embedding is limited to PNG so Excel, CSV, and PDF (including download buttons) are not possible.

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 full workbooks, individual workbook pages, and single element embedding.

  1. Open the workbook. 
  2. If the workbook is in Edit mode:
    • Click Publish to publish your changes.
      Then c      lick Editing > Go to published version.
      or 
    • Click Editing > Go to published version to return to the latest published version. 
      Screen_Shot_2022-02-10_at_11.58.06_AM.png
  3. Click the caret (▼) button to the right of the workbook title.
  4. Select Embedding.
    This will open the Embedding modal.
    Screen_Shot_2022-02-10_at_2.16.14_PM.png
  5. Open the Public tab.

  6. Under Generate Public URL for, select your embed target.
    Options will include the entire workbook, all individual workbook pages, and all individual data elements. 
  7. A public link and the embed code will automatically be generated.
    The embed code is an iframe with its `src` property set to the public link url.Screen_Shot_2021-05-20_at_8.27.15_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 workbook. 
  2. If the workbook is in a draft state, click the Publish button.
    A workbook must be published to create or manage embeds.
  3. Click the vertical ••• menu icon in the workbook header.
  4. Click Embedding to open the Embed Workbook modal.
    Screen_Shot_2021-05-20_at_8.18.29_PM.png
  5. This modal displays all available public and application embeds.
    It opens to the Public embed tab by default.
  6. Click the trashcan icon at the top right of the embed you would like to delete.
    Screen_Shot_2021-05-20_at_10.10.24_PM.png
  7. If you have not done so already, delete the embed code from your non-Sigma application.

Disable Public Embedding

  1. Open your Admin Portal
  2. On the Account page, find the section titled Features.
  3. Click the toggle switch next to Public Embeds.
    Screen_Shot_2021-11-19_at_3.25.41_PM_copy_3.png

Related Resources

Workbook Embedding: An Overview
Application Embedding
Private Embedding
Embed Management
Workbook Controls in the URL

Was this page helpful?
Yes No