1. Embedding Documentation
  2. Option 2: iFrame

What is an iFrame?

The HTML Inline Frame element (<iframe>) represents a nested browsing context, embedding another HTML page into the current one. You can read more about iFrames here.

Where can I use the component?

Since the web component is an HTML element, you can use it in any context:

  • Directly in an HTML file

  • Define it in vanilla JS

  • Any JS web framework: React, Vue, Angular, etc

The iFrame is powered by an Explo URL that will need to be constructed.

https://app.explo.co/iframe/<dashboard_id>/<user_group_token>/<environment>

URL Attributes

Attribute NameTypeDescription
dashboard_idstringThis is the dashboard embed id that you retrieve from the Explo application.
user_group_tokenstringThe user_group_token is the token you use to identify the customer that is viewing the dashboard. This is retrieved via the End User Group API.
environmentstringThe environment name (such as production or staging) that you would like to embed. If no environment is provided, the most recent saved version will be rendered.
refresh_minutesnumberThe cadence on which you want the dashboard to automatically refresh data. (Optional)
locale_codestringAn optional argument that overrides any localization settings for your team. This will localize your dashboard’s numbers, currencies, and dates to the desired locale, if supported.

Embed the iFrame below into your web application.

<iframe
  src="https://app.explo.co/iframe/<dashboard_id>/<user_group_token>"
  style="width: 100%;border: none;height: 100vh;">
</iframe>