You are viewing our older product's guide. Click here for the documentation of GoodData Cloud, our latest and most advanced product.
Embedding Parameters
This section addresses the embedded dashboards and reports that are part of the Pixel-perfect interface (see GoodData Portal).
For embedded Analytical Designer and KPI Dashboards, see Embed Analytical Designer and Embed a KPI Dashboard.
You can embed a dashboard using an HTML iframe.
You can parametrize the source URL with the following parameters.
In GoodData, terms workspace and project denote the same entity. For example, project ID is exactly the same as workspace ID. See Find the Workspace ID.
| Parameter | Required? | Value | Description | Example value |
|---|---|---|---|---|
project | yes | The workspace URI | The workspace where the dashboard is located | /gdc/projects/wwhd8rif9q18pqlqcsf1j69wfhsglcfz |
dashboard | yes | The dashboard URI | The dashboard to embed | /gdc/md/wwhd8rif9q18pqlqcsf1j69wfhsglcfz/obj/1442 |
tab | no | The tab ID | The initial tab to display | a6d9bf0e1861 |
nochrome | no | true/false | If true, hide the header (tabs, print, and edit icons) – see Hide the Header of an Embedded Dashboard | true |
override | no | A comma-separated list of event names | See Embedded Dashboard Events. | ui.link |
Embedding Code Format
The following is an example reference, using all of the above parameters:
<iframe frameborder="0" src="https://secure.gooddata.com/dashboard.html#project={project_uri}&dashboard={dashboard_uri}&tab={tab_id}&override={event1,event2,...,eventN}&nochrome=1" width="100%" height="380px" allowtransparency="false"></iframe>
Filtering an Embedded Dashboard via URL Parameters
Optionally, you can apply attribute filters to your embedded dashboards. These filters are referenced as URL parameters. See Filtering Embedded Dashboard via URL parameters.