dashboards
DashboardSpec
Description of a single dashboard that is available in the platform.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
| dashboard_name | Dashboard name | string |
| url | Dashboard url | string |
| width | Dashboard width (px) | integer |
| height | Dashboard height (px) | integer |
| disable_thumbnail | Disables showing a thumbnail. A thumbnail url for Looker Studio dashboards is generated by adding /thumbnail to the end of the dashboard's url. It is a Google generated thumbnail of the dashboard. | boolean |
| parameters | Key/value dictionary of additional parameters to be passed to the dashboard | Dict[string, string] |
AuthenticatedDashboardModel
Model that describes a single authenticated dashboard.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
| folder_path | Folder path | string |
| dashboard | Dashboard model with an unauthenticated url | DashboardSpec |
| authenticated_dashboard_url | Dashboard authenticated url with a short lived refresh token | string |
DashboardListSpec
List of dashboards.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
| self | List[DashboardSpec] |
DashboardsFolderListSpec
List of dashboard folders.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
| self | List[DashboardsFolderSpec] |
DashboardsFolderSpec
Description of a folder with multiple dashboards or other folders.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
| folder_name | Folder name | string |
| dashboards | List of data quality dashboard at this level. | DashboardListSpec |
| folders | List of data quality dashboard folders at this level. | DashboardsFolderListSpec |