Documentation

Extra iframe Parameters

In datapine you can use 4 extra iframe parameters: dashboard, chart, chartGroup, and tab.

 

a) dashboard

 

The iframe parameter dashboard allows to directly load a dashboard to which the user has access in the token. It accepts multiple dashboards separated by a comma.

 

The iframe link will look like this:

 

https://datapine.com/organization/{organization_id}/iframe?dashboard=Sales

 

The parameter has the following behavior:
– If it is present with one value, we open this dashboard directly and there is no dashboard dropdown. In case the dashboard doesn’t exist, we open the predefined dashboard configured in your token.

–  If the parameter is present with multiple dashboards, in case the predefined dashboard is in the list, we will open that directly. If a predefined dashboard is not in the list, the first one takes the preference. Furthermore, the dashboard will be loaded with the dashboard dropdown selector.

 

Below you find a link example with multiple dashboards:

 

https://datapine.com/organization/{organization_id}/iframe?dashboard=Sales,Marketing

 

In order to work, we will send you the parameter to your login URL as a new parameter besides the callback, like described in step 4 in the request flow overview.

 

iFrame redirect example (4.):

 

https://customer.com/sso/login?ssoCallback=https%3A%2F%2Fcustomer.com%2Fsso%2Flogin%3FssoCallback%3Dhttps%3A%2F%2Fdatapine.com%2Fmvc%2Fsso%2Fcallback%2Forganization%2F%7Borganization_id%7D%2F&dashboard=Sales,Marketing

 

And that parameter needs to return to us in step 5 when you do the redirection to our SSO call API.

 

Customer redirect example (5.):

 

https://secure.datapine.com/mvc/sso/callback/organization/{organization_id}?token={encoded_token}&dashboard=Sales,Marketing

 

b) chart

 

The iframe parameter chart allows to directly load a chart.

 

The user must have access to the dashboard inside his token or be an admin that has full access.

 

The parameter only accepts one value.

 

The iframe link will look like this:

 

https://datapine.com/organization/{organization_id}/iframe?dashboard=Sales&chart=Revenue

 

c) chartGroup

 

The iframe parameter chartGroup allows to directly load a group of charts from a dashboard.

 

The user must have access to the dashboard inside his token or be an admin that has full access.

 

The parameter only accepts one value.

 

The iframe link will look like this:

 

https://datapine.com/organization/{organization_id}/iframe?dashboard=Sales&chartGroup=AllRevenueCharts

 

d) tab

 

The iframe parameter tab is optional and only can be used when you use one of the above parameters, chart, or chartGroup in your iframe link. For example, you can use it to add a tab to help you to locate your chart.

 

It helps to identify the chart or chart group that you want to share, in case they have the same name across multiple tabs in your dashboard.

 

The iframe link will look like this:

 

https://datapine.com/organization/{organization_id}/iframe?dashboard=Sales&tab=IntenalSales&chart=Revenue