Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Embedding Dashboards


Public Beta

The following feature is available as public beta in Flex UI version 1.28 and later. To use this feature, please make sure Insights - Programmable Dashboards public beta feature is enabled in your admin interface.



A developer proxy is needed for local development. Please refer to the article about Local Development.

Starting in version 1.27, Flex supports Dashboard embedding. To utilize this functionality, use the Dashboard component exported under the Flex.Insights.Dashboard namespace.

The component takes a dashboardId prop and displays that dashboard embedded in an iframe. This allows you to create custom views with particular dashboards.

Dashboard component

dashboard-component page anchor

The component has the following props:

  • dashboardId: string;
  • queryParams?: {};
  • events?: { [event: string]: (eventData: unknown, eventId: string) => void };


dashboardid page anchor

The ID of the dashboard. This is the only required prop on this component and most likely the only one you will need to use.

Please refer to the next chapter to learn how to get dashboardId.

For expert users. The object will be passed as query string to the iframe URL.

For expert users. Allows you to attach custom handlers to the post message events received from the iframe.

Getting the Dashboard ID

getting-the-dashboard-id page anchor

Knowing the Dashboard ID is crucial for being able to render it. To figure out the correct Dashboard ID, navigate to the desired dashboard first and check the URL in your browser.

It should look something like this: <yourFlexUrl>/dashboards/aeJSfSg9if1x.

The part after dashboards/ is the currently displayed Dashboard's ID, in this case aeJSfSg9if1x.

We will use the Dashboard ID we just discovered to display the Dashboard as content of the CRM container:

<Flex.Insights.Dashboard key="some-key" dashboardId="aeJSfSg9if1x" />

Rate this page: