​
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/report-builder/iframe/<jwt>/<environment>

​
Use a Report Builder Id and Customer Token

https://app.explo.co/report-builder/iframe/<report_builder_id>/<customer_token>/<environment>

​
URL Attributes

Attribute NameTypeDescription
jwt (recommended)stringThis is the embed secret (JWT) for the report builder. We recommend you use this attribute instead of the report_builder_id and customer_token. Read more about embed secrets here.
report_builder_idstringThis is the embed id that you retrieve from the Explo application.
customer_tokenstringThe customer_token is the token you use to identify the customer that is viewing the report builder. This is retrieved via the Customer 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.
locale_codestringAn optional argument that overrides any localization settings for your team. This will localize your report builder’s numbers, currencies, and dates to the desired locale, if supported. Check out support languages here.
currency_codestringAn optional argument that overrides any currency localization settings for your team. This will localize your report builder’s currency symbols and format to the desired locale, if supported. Check out support currencies here.
timezonestringAn optional argument that allows you to specify a timezone to display dates in. Valid values can be found here.
themestringAn optional argument that lets you manage multiple style/theme profiles within Explo. If not provided, uses the “default” theme.
Embed the IFrame below into your web application. The IFrame is backward-compatible with the previous Report Builder Customer Token syntax, but we recommend using the Embed Secret (JWT) syntax. Read more about embed secrets here. 
<iframe
  src="https://app.explo.co/report-builder/iframe/<jwt>
  style="width: 100%;border: none;height: 100vh;"
>
</iframe>
Please also note these instructions when embedding a report builder.