FAQs: Differences between Embedding 1.0 and 2.0
What are the changes in functionality with Embedding 2.0?
Embedded dashboards will now be able to use more of the interactive dashboard functionality previously only available within Chartio directly. This includes dashboard variables, Drilldowns to current dashboards as well as series filtering.
How is a dashboard embedded?
1.0: Each dashboard is embedded using JSON web tokens (JWT) and HTML iframes but reflected into your site as an image.
2.0: Dashboards are still embedded in the same way but will now have the option to reflect more of the functionalities of a dashboard within Chartio directly. You can choose whether or not you would like users to be able to update the dashboard variables for each embedded dashboard.
Full Embedding 2.0 instructions can be found here.
Are there any changes in how the payload is submitted?
1.0: When submitting the JWT in an HTML iframe, the BASE_URL uses the Dashboard Id for each embedded dashboard.
2.0: The format of the payload remains the same but the BASE_URL will now use your Account Slug, used to log into Chartio, and the Dashboard Slug, found in the URL to your dashboard in Chartio.
The embed_token url parameter now also sets a cookie, which is your authentication for the rest of the session.
Embedding 1.0 BASE_URL
Embedding 2.0 BASE_URL
Can I use variables or filters in my embedded dashboards?
1.0: Chartio-native 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.
2.0: Chartio-native filters can now be used within any embedded dashboard. Embedding 2.0 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 in 2.0, you will need to update the BASE_URL as shown in the question above.
What happens to dashboards already embedded after 2.0 is rolled out?
Your dashboards will continue to work as usual until we fully deprecate version 1.0 later this year. We will notify customers before this is scheduled to happen to give everyone time to move their dashboards to 2.0.
Can I embed a dashboard previously embedded with 1.0 into a new page?
Dashboard currently embedded with 1.0 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: Once we deprecate 1.0, URLs with Dashboard Ids will no longer work. It is therefore 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, 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 less rows or edit the column width.
Another option is to download a browser extension to take a full page screen capture of your dashboard such as Full Page Screen Capture.
Can I use themes and custom colors in my embedded dashboards?
1.0: Dashboards will be embedded with the Chartio default theme.
2.0: You can now use all your custom colors and themes in your embedded dashboards.
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 of 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 recommended disabling this feature if you have a 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 are 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, verify your payload contains a JWT expiration value of 24 hours or less.
If you are using the embed URL directly, ensure your URL matches the new format using the Dashboard Slug.
How can I add Embedding 2.0 to my plan?
If you would like to start using Embedding, please reach out to us at firstname.lastname@example.org to upgrade your plan.
I have more questions about Embedding 2.0, who can I contact?
If we missed anything or if you’re running into any issues switching from 1.0 to 2.0, don’t hesitate to reach out to our Success team at email@example.com.