Documentation Embedding FAQs

Transition to Interactive Embedding

FAQs: Differences between Interactive Embedding and the old version

What are the changes in functionality with Interactive Embedding?

Embedded dashboards are now able to use more of the interactive dashboard functionality previously only available within Chartio directly. This includes Dashboard Variables and Drilldowns to current dashboards as well as series filtering.

How is a dashboard embedded?

Old version: Each dashboard is embedded using JSON web tokens (JWT) and HTML iframes but reflected into your site as an image.

Interactive Embedding: Dashboards are still embedded in the same way but will now have the option to reflect more of the dashboard functionalities available within Chartio. You can choose whether or not you would like users to be able to update the Dashboard Variables for each embedded dashboard.

See our full Embedding instructions for more information.

Are there any changes in how the payload is submitted?

Old version: When submitting the JWT in an HTML iframe, the BASE_URL uses the Dashboard ID for each embedded dashboard.

Interactive Embedding: The format of the payload remains the same but the BASE_URL will now use your organization’s Slug, which is used to log into Chartio, and the Dashboard Slug, which is found in the URL to your dashboard in Chartio.

Old version BASE_URL

https://embed.chartio.com/d/id

Interactive Embedding BASE_URL

https://embed.chartio.com/d/org-slug/dashboard-slug/

Can I use Variables or filters in my embedded dashboards?

Old version: Native Chartio Variables are not available as part of the embedding process. Users can add env variables within their application directly and use them to filter their embedded Chartio dashboards using Hidden Variables.

Interactive Embedding: Native Chartio Variables (e.g., Dashboard Variables and Drilldowns) can now be used within any embedded dashboard. Interactive Embedding includes an option to disable filters for each embedded dashboard by unchecking the Allow Viewers to Apply Dashboard Variables setting. This will let you keep using env variables to filter your embedded dashboards and disable any variables on the dashboard, except Hidden Variables.

If you would like to use your Dashboards Variables currently existing on your Chartio dashboard within your embedded page, you will be able to use them as you would within Chartio. To use the Dashboard Variables with Interactive Embedding, you will need to update the BASE_URL as shown in the question above.

What happens to dashboards already embedded after Interactive Embedding is rolled out?

Your dashboards will continue to work as usual. We will notify customers beforehand if anything changes or if the old version is ever deprecated.

Can I embed a dashboard previously embedded with the old version into a new page?

Dashboards currently embedded with the old version will continue to be embedded and work as usual. Newly embedded dashboards can be created using either the Dashboard ID or the Dashboard Slug in the BASE_URL.

Note: If the old version is ever deprecated, URLs with Dashboard IDs will no longer work. Therefore, it is recommended to use the Dashboard Slug when embedding any new dashboards.

Can I download my charts from my embedded dashboard?

Dashboards embedded in either version do not have a direct download option. You can, however, perform one of the following options:

  • Set up a download link in your application;
  • Download table charts as CSVs from within the extended result view by clicking on the View all x rows and y columns link at the bottom of your table charts. If you don’t see this message and would like to force this view, simply adjust your table chart within Chartio to show fewer rows or edit the column width;
  • Download a browser extension to take a full-page screen capture of your embedded dashboard such as Full Page Screen Capture.

Can I use themes and custom colors in my embedded dashboards?

Old version: Dashboards will be embedded with the Chartio default theme.

Interactive Embedding: You can now use all your custom colors and themes in your embedded dashboards.

Is there still a size limit for my embedded dashboards?

Old version: Chartio holds all the returned queries from the embedded dashboard until all results are returned before pushing to the embedded dashboard. The maximum size of the returned charts for the embedded dashboard cannot exceed 10MB.

Interactive Embedding: We load the full dashboard in an iframe. Therefore, your dashboard will load incrementally as a dashboard normally would in Chartio directly.

How is caching handled for my embedded dashboards?

Old version: Queries relating to an embedded dashboard are only run when the iframe src URL is requested with a brand new JWT. The results are cached for all subsequent requests until the JWT expires, allowing an opportunity to pre-populate a cache with common iframe src URLs by requesting them server-side before end users ever request the URLs. This eliminates any loading time end users would have had to endure waiting for the queries to complete. However, this is not required, and the mechanism you choose to build this cache is entirely up to you (e.g., lazy load, batch job, etc.).

Interactive Embedding: Interactive Embedding embeds the native Chartio dashboard, so the embedded dashboard will use the cache settings for that dashboard in Chartio.

Are there any visual differences between the embedded dashboards?

Because Interactive Embedding uses Chartio’s native UI elements, dashboard titles are now visible for embedded dashboards; previously, they were not shown. As mentioned in the question above, dashboard themes are also applied.

How are my variables applied if I have disabled “Auto Apply Variables”?

If you’ve disabled Auto Apply Variables on your dashboard, this will also be reflected in your embedded dashboard. You’ll be able to select the values for all your variables before any queries are sent to your database. Once you’ve selected all the variable values you wish to change, simply click on the Apply Filters button on the top right on your embedded dashboard.

We recommend disabling this feature if you have a large number of variables on your dashboard to prevent sending additional queries and JWT tokens to your database.

How do I update my embed URL generation script?

If you’re using a script to generate the embed URL, retrieve the example code as described in the setup instructions and update your script to match the functionality. Ensure the JWT token is a GET parameter instead of part of the URL. Additionally, make sure your payload contains a JWT expiration value of 24 hours or less.

If you’re using the embed URL directly, ensure your URL matches the new format using the Dashboard Slug.

How can I add Interactive Embedding to my plan?

If you’d like to start using Interactive Embedding, please reach out to us at sales@chartio.com to upgrade your plan.

I have more questions about Embedding, who can I contact?

If we missed anything or if you’re running into any issues switching from the old version to Interactive Embedding, don’t hesitate to reach out to our Success team at support@chartio.com.