Skip to main content

Intro

After configuring, creating, and mapping to the publishing organization and selecting your interfacing settings with the Brand Kit, the next step is to publish or embed your content for others to see. You can embed content within any website, application, or portal. Learn more about publishing content to subscribers. This article describes the various embed methods and provides information on embedding cards and dashboards using each method.

Embed Methods - Public and Private

There are two main ways to embed content: public and private.

Public Embed

Important: Due to security reasons, the option to embed content PUBLICLY is unavailable for HIPAA-compliant Domo instances. The PRIVATE embed options are available.
You can embed publicly on websites, blogs, or social media platforms like Facebook and Twitter. Anyone with the embed URL can view the content. This public content is view-only, does not support Alerts, and, since it does not require viewers to log in, does not support Personalized Data Permissions (PDP).
Important: AppDB in Domo Bricks is blocked in public embed contexts due to security concerns and trust requirements.
You can enable and disable public embedding in Domo Everywhere > Settings > General by checking or unchecking the box to Allow public embedding of Cards and Dashboards.
Screen_Shot_2022-10-18_at_6.17.22_AM.png

Private Embed

You can embed privately in websites, portals, or applications. There are three options for privately embedding content:
  • User-Based — Supports Single Sign-on (SSO) and Personalized Data Permissions (PDP). User licenses are created in Domo, and PDP policies apply to known users based on row-level entitlement policies. This option is the easiest to configure from a technical standpoint but can be difficult to manage for large numbers of users with varying Filters and permissions. It is recommended for small, consistent user groups. To implement, purchase user licenses.
  • Server-Based This method uses programmatic server-side filtering. The environment that hosts the Domo embedded content is authenticated against Domo and programmatically determines what filters to apply. The Filter requests are then sent to Domo when the embedded content is displayed. This option provides the greatest flexibility. It works well for large or transient user groups but carries a higher technical debt, as it requires a developer to create and maintain the programmatic Filters. To implement this, you can purchase impressions (or card loads). For more information, see Embed in the developer portal.
  • Platform-Based — Supports SSO and PDP and is a completely editable experience. This option is the easiest to build and deploy full data experiences to your customers using the Domo platform. To implement, purchase a platform package with a Domo environment for every customer you want to deliver content.

Embed Notes

For public and private user-based embed, you need to copy the automatically generated HTML string from Domo and paste it into the necessary location on the subscriber instance as an iFrame or via a JavaScript API. For all privately embedded content:
  • Users with a Social role cannot embed, create an iFrame, or view privately embedded content. Participant users cannot embed but can view privately embedded content.
  • All card types are supported except Sumo Pivot Tables.
  • Notebook and Doc cards cannot be embedded independently but can be embedded as part of a dashboard.
Note: You can only own one embed type per card/dashboard. To locate the embed ID, go to More > Admin. In the Domo Everywhere menu, select Embed. Go to the Cards or Dashboards tab and locate the card or dashboard. Then, locate the entry for that asset in the Embed ID column.
For private user-based and platform-based embedded cards or dashboards (this does not pertain to server-based):
  • You must enable SSO (Single Sign-On) in Domo and on the website, portal, or application.
  • If the Only Invited People Can Access Domo option is enabled in Admin Settings > SSO, any non-Domo user attempting to access the card is denied. If this option is disabled, a non-Domo user is auto-provisioned based on the access rights set for default users. The default setting is “Privileged.” For more information about access rights, see Controlling Access in Domo.
For publicly embedded content:
  • Titles, drill down, Summary Numbers, and the chart picker are all available when embedding cards publicly; however, filters are only available for columns used in the card. For security reasons, the end-of-card table view is not available with this feature.
  • If you do not want to embed cards publicly, disable the functionality by going to Admin Settings > Company Settings > Company Overview. U ncheck the box for Publicly embed content.
You can get an administrative view of embedded content using the Activity Log. If you need further assistance selecting the right embed method, contact your Account Executive (AE) or Customer Success Manager (CSM) to discuss the best option for your use case and organization.

Enable Domo Embed

To enable Domo Embed, a user with an Admin default security role or a custom role with the Embed Cards grant must go to Admin Settings > Company Settings > Company Overview and check the box for Publicly embed content.
Important: This is a 30-day free trial. After the first 30 days of use, your Domo account representative will contact you to discuss pricing.

Authorized Domains

You can use Embed Authorized Domains to place domains on an allowlist, which helps keep your data secure and only displayed in the places you want. Domains on the allowlist can have content embedded and receive events via the JS API. If content is placed in an unauthorized domain, it does not load. To learn more about this, see the Domo developer docs .
Important: If you do not add domains to the allowlist, then cards and dashboards can be embedded in any domain, but the JS API and Domo loading process is blocked.
  1. To add authorized domains, go to Domo Everywhere > Settings.
  2. In the General tab, locate Embed authorized domains and enter a Domain name.
  3. Select Add.
The list of authorized domains displays below the Domain name field.
Screen_Shot_2022-10-18_at_6.18.03_AM.png

Embedding Cards

When embedding cards individually, note that you can embed multiple cards on a dashboard, but you must generate code for each card independently. For individually embedded cards, you can choose whether or not to include card features regularly available in the Details view, including all of the following: You can also set the size of embedded cards, either by choosing a preset size or entering a custom width and height.

Embed Cards Publicly

Access the embed option for a card by selecting Card options > Domo Everywhere.
domo_embed_option.png
The embed card modal displays.
Screenshot 2024-08-15 at 11.02.54 AM.png
This table describes the parts of the modal:

Component

Description

Display options

Lets you toggle certain card features on or off in the embedded card. The following toggles are available:

  • Show title — Displays the card title.
  • Allow drill — Allows the embedded card to display drill options and navigate to clicked HTML links.
  • Allow export — Toggles the ability to export the card.
  • Allow table view — Allows the embedded card to be displayed in a table view.
  • Show summary number — Displays the card’s summary number.
  • Allow filter changes — Allows filters to be changed in the embedded card view.
  • Allow chart picker — Enables the chart picker in the embedded card view.

Sizing options

Allows you to set the size of the embedded Domo card.

Three default sizes are available: Square (600 x 600 pixels), Portrait (600 x 900) pixels, and Landscape (900 x 600 pixels).
There is also a Custom option, which allows you to set your own custom width and height.

Embed options

Lets you specify if the card should be embedded privately (default) or publicly.

If you choose to make a card public, anyone can view the card and the data it displays. This also gives Domo permission to publish the card as part of the public card newsfeed.

When you select the Public option, a URL is generated (under the Share link ), which you can copy and paste into the desired host site. You can also directly open any of the five social media platforms available (Facebook, Twitter, Google+, LinkedIn, or Pinterest), to embed the card immediately.

Embed code

Displays the automatically generated HTML string you copy and paste into the website, portal, or application. You can copy the code by selecting Copy beside the field.

To embed a card publicly, follow these steps:
  1. Navigate to the dashboard where the card displays or the Details view for the card.
  2. Select Card options > Domo Everywhere. The embed card modal displays.
  3. Set the card size:
    • Select a preset size for the embedded Card in the Default Size menu OR
    • Select Custom and enter the desired dimensions in the Width and Height fields in pixels.
  4. Check the boxes for all the Display options you want to include in the embedded card.
    Note: Allow table view and Allow filter changes are not currently available for publicly embedded cards.
  5. Select Publicly Available from the Embed Options list.
  6. Select Make Public.
  7. Select Copy to copy the automatically generated URL.
  8. (Conditional) To embed the card in any of the following five social media platforms—Facebook, Twitter, Google+, LinkedIn, or Pinterest—select the icon for the desired platform, log in if necessary, and paste the URL as required by the platform. Otherwise, open your website or blog and paste the URL as necessary.

Embed Card Privately

Follow these steps to embed a card privately:
  1. Navigate to the dashboard where the card displays or the Details view for the card.
  2. Select Card options > Domo Everywhere. The embed card modal displays.
  3. Set the card size:
    • Select a preset size for the embedded Card in the Default Size menu OR
    • Select Custom and enter the desired dimensions in the Width and Height fields in pixels.
  4. Check the boxes for all the Display options you want to include in the embedded card.
  5. Select Private from the Embed options list.
  6. Select Copy to copy the HTML to embed.
  7. Paste the HTML into the website, portal, or application where you want the card to display. The specific instructions vary depending on the website, portal, or application.
Important: The card must be shared with the users accessing the embedded content in order for them to be able to view it.

Use the JavaScript API to Filter Embedded Cards and Dashboards

Please visit Embedded Analytics in the developer docs for code examples of using the JavaScript API to filter embedded content.

Track Publicly Embedded Cards

You can keep track of all publicly embedded Cards in your Domo instance in Admin Settings > Domo Everywhere. You can see information such as embed creator, current embed link status (public or disabled), and number of public views. You must have an Admin security role or a custom role with the Embed Cards grant to see this tab.

Whole-Page Filtering

Individually embedded cards have more format and layout flexibility than a Domo dashboard. The Whole-Page Filtering feature lets you use Filters from Domo dashboards and embedded cards in your authorized domains. You can create filters for your use cases and apply filter parameters to every embedded card on your page. In the image below, the Country Filter is applied to each individual embedded card to see the data on confirmed Covid-19 cases, currently infected, deaths, and cumulative trend for Greenland and Greece.
whole-page_filtering.png

Embed Dashboards

For Domo dashboards, you can choose whether or not to include the following options:
  • Dashboard title
  • Show Filter bar
  • Export of the raw data of each Card to CSV
  • Persist filters, which automatically append pfilter parameters to the end of any custom interaction links
  • Opening of links in a new tab
Important: When embedding a dashboard with sub-pages, the order of the pages is user-specific. Users can re-order the pages in Manage Pages or the sub-page order can be locked if the dashboard is set as a company page.
You can embed any Domo dashboard by selecting Share > Embed Dashboard on the dashboard you want to embed.
Note: With dashboard embed, you can only embed using an iFrame, not a JavaScript API, as you can with card embed.
The Embed Dashboard modal includes several display options and components for configuring your embedded dashboard.
You can use the following table to learn more about the parts of the modal.

Component

Description

Display options

Lets you toggle certain features on or off in the cards on the embedded dashboard. The toggles include:

  • Show title — Toggles the dashboard title. The title can be hidden if you have already labeled the content on the host page containing the iFrame.

  • Allow interactions and filtering — Allows you to enable interactions and filtering on embedded dashboard cards. You should turn off this option if you want to lock down your embedded content (usually only for public embed).
    Interactions include opening the card Details view in a new browser tab, opening a specified web page, and enabling drilling into the card. For more information about configuring interactions in dashboards, see Creating Domo Dashboards or transforming the data to exclude the columns.

  • Show filter bar — Toggles the Filter bar on the dashboard.
  • Allow export — Allows users to export the raw data for each card in CSV format. (The Export button displays when you hover over cards in the embedded dashboard).

  • Allow maximization Opens a pop-up window with the card Details view. This lets you see more details and interact with the card, including quick filters and additional export options.

  • Persist Filters — Enables persist filters, which automatically append pfilter parameters to the ends of any custom interaction links so that the content maintains context around filters on the dashboard. Learn more in our developer portal .

  • Open links in new tab — When you click on links in cards, they are opened in a new browser window; or else, the new content opens within the iFrame. (The Allow interactions and filtering option must be checked for links to be clickable.)

Sizing options

Allow you to set the width and height of the embedded Domo dashboard.

Embed options

Lets you specify whether the dashboard should be privately or publically embedded (the default option is Off ). If you choose to make the dashboard public, anyone can view the content.

When you choose the Public option, a URL is generated (under Share link ), which you can copy and paste into the desired website, blog, or social media platform. The public embed option is not authenticated, so filters cannot be personalized.

When you choose the Private option, users must authenticate to see the embedded content. Because the private embed option uses authentication, filters can be personalized using PDP or programmatic filters.

Share link

Allows you to view the embedded dashboard directly.

Embed code

Displays the automatically generated HTML string you copy and paste into the website, portal, or application. You can copy the HTML by clicking to the right of the HTML string.

Embed ID

Used in the HTML embed code in programmatic filtering. Learn more about programmatic filtering in the developer portal .

Export DataSet mapping

Lets you download a CSV file that lists all of the original DataSet IDs used in the cards on the Domo dashboard and maps them to the obfuscated DataSource IDs that can be used outside the Domo platform.

Embed a Dashboard Publicly

Follow these steps to embed a dashboard publicly:
  1. Navigate to the dashboard in Domo.
  2. Go to Share > Embed Dashboard.
Screenshot 2024-11-19 at 9.10.53 AM.png
  1. Check the boxes for all the Display options you want to include in the embedded dashboard.
  2. Enter the desired dimensions in the Width and Height fields in pixels.
  3. Select Public from the Embed options list.
  4. Select Copy to copy the automatically generated URL.
  5. Paste the embed code into the website, portal, or application where you want the Domo dashboard to display. The specific instructions vary depending on the website, portal, or application.

Embed a Dashboard Privately

  1. Navigate to the dashboard in Domo.
  2. Go to Share > Embed Dashboard.
Expand.jpg
  1. Check the boxes for all the Display options you want to include in the embedded dashboard.
  2. Enter the desired dimensions in the Width and Height fields in pixels.
  3. Select Private from the Embed options list.
  4. Select Copy to copy Embed code.
  5. Paste the embed code into the website, portal, or application where you want the dashboard to display. The specific instructions vary depending on the website, portal, or application.
Important: The dashboard must be shared with the users accessing the embedded content so that they can view it.

Embed a Sub-page

When embedding a dashboard, either publically or privately, you can also embed the dashboard’s sub-pages.

Embed Domo Instance

You can embed an entire Domo instance as long as it is not the primary instance for the Domo account. Any instance currently set as the primary on the account is configured by default to prevent the full instance from being embedded.

Configure Private Embed with PDP

Private embed leverages Domo’s SSO to authenticate users on the Domo platform. Embedded content is then served to the end user via the Javascript API or iFrames. You can pair private embed with PDP to serve appropriate content to end users, including external users. If you use embed to serve content to external end users, one of the two methods is preferred:
  • Embed cards from a white-labeled subscriber instance. This allows end users to access the Domo application and only see a white-labeled instance (e.g., no Buzz functionality). Learn more about Publishing Content to a Subscriber Instance.
  • Use programmatic embed. When using programmatic embed, users are not actually authenticated users of Domo and cannot access the Domo application. This means that the portal or application code handles authentication and ensures users can see the appropriate data. Learn more in the developer portal .

Implement Private Embed

Follow these steps to implement private embed with PDP:
  1. Set up Single Sign-On (SSO). For more information, see Understanding and Configuring Domo Single Sign-On Using SAML.
  2. Enable Private embed.
  3. Set up PDP. For more information, see Personalized Data Permissions (PDP).
  4. Configure cards and dashboards for embedding. To see all cards and dashboards configured for embedding in your Domo environment, go to Admin Settings > Domo Everywhere > Embed.
  5. Embed cards and dashboards using iFrame or Javascript code in the portal or application.
Important: The cards and pages must be shared with the users accessing the embedded content in order for them to be able to view it.

Impression Tracking

After embedding a card, you can track the number of new card loads or impressions from the Usage page in Company Settings. To access the Usage page from the navigation header, select More > Admin Settings. Under Company Settings, select Usage. The Usage page contains several tabs. Go to the Impressions tab to view information about your embedded content.
impressions tab.jpg
There are four types of embedded content:
  • Private card embed
  • Private dashboard embed
  • Public card embed
  • Public dashboard embed
For public and private dashboard counts, the number refers to new loads of cards located on an embedded dashboard. Impressions for individually embedded cards are counted and displayed as Private card embed or Public card embed impressions.
embed type callout.jpg
You can view your impressions history by using the Viewing dropdown.
view history.jpg

3rd Party Analytics

By default, Domo tracks content interactions, including cards, dashboards, loads, and interactions like filters, drill paths used, and exports. The 3rd Party Analytics feature allows you to monitor your digital experience and use Digital Experience Intelligence (DXI) solutions like FullStory, Sprig, or Heap to track advanced interactions.

Enable FullStory Tracking

Follow these steps to enable FullStory tracking for your embedded content.
  1. Contact your Domo account team to enable the embedded analytics feature.
  2. Send your team the necessary code snippet to install FullStory on your website. You can get this from your FullStory account.
    Screenshot 2024-01-22 at 10.50.51 AM.png
  3. Request enablement for Canvas Capture from your FullStory account representative.

FAQ

“Loading all of Domo in an iframe” refers to embedding the entire Domo platform rather than just a single card or dashboard. This is often done by putting the Domo instance domain (customer_name.domo.domo) as an src of an iframe. There are security concerns around embedding the entire platform this way, so it is restricted to the domains specified here.
  • If no domains are listed, then content can be embedded on any site.
  • If no domains are listed, then using a JS API in embed use cases does not work.
  • If domains are listed, then content embedded in any other domain does not load.
  • If domains are listed, then the JS API does work.

Need Support?

If you need support with your embedded content, contact us here: support@domo.com .
  • Include the following information in your request:
  • Domo environment(s) where the behavior is occurring
  • Description of behavior
  • Screenshot of behavior (if applicable)
  • Steps to recreate behavior (if known/applicable)