Last updated: July 22, 2025
DQOps YAML file definitions
The definition of YAML files used by DQOps to configure the data sources, monitored tables, and the configuration of activated data quality checks.
DashboardYaml
Data quality dashboard definition YAML schema for a data quality dashboards list specification.
The structure of this object is described below
| Property name | Description | Data type | Enum values | Default value | Sample values |
|---|---|---|---|---|---|
api_version |
DQOps YAML schema version | string | dqo/v1 | ||
kind |
File type | enum | source table sensor provider_sensor rule check settings file_index connection_similarity_index dashboards default_schedules default_checks default_table_checks default_column_checks default_notifications |
dashboards | |
spec |
The data quality dashboards folder tree with the definition of custom dashboards | DashboardsFolderListSpec |
DashboardsFolderListSpec
List of dashboard folders.
The structure of this object is described below
| Property name | Description | Data type | Enum values | Default value | Sample values |
|---|---|---|---|---|---|
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 | Enum values | Default value | Sample values |
|---|---|---|---|---|---|
folder_name |
Folder name | string | |||
standard |
Always shows this schema tree node because it contains standard dashboards. Set the value to false to show this folder only when advanced dashboards are enabled. | boolean | |||
dashboards |
List of data quality dashboard at this level. | DashboardListSpec | |||
folders |
List of data quality dashboard folders at this level. | DashboardsFolderListSpec | |||
hide_folder |
Hides the whole folder and all nested dashboards from the navigation tree. If you want to hide some of the build-in folders, update the settings/dashboardslist.dqodashboards.yaml file in the DQOps user home folder, create an empty folder with the same name as a built-in folder, and set the value of this field to true. | boolean |
DashboardListSpec
List of dashboards.
The structure of this object is described below
| Property name | Description | Data type | Enum values | Default value | Sample values |
|---|---|---|---|---|---|
self |
List[DashboardSpec] |
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 | Enum values | Default value | Sample values |
|---|---|---|---|---|---|
dashboard_name |
Dashboard name | string | |||
url |
Dashboard url | string | |||
width |
Dashboard width (px) | integer | |||
height |
Dashboard height (px) | integer | |||
standard |
Shows the dashboard always in the data quality dashboard section. The dashboards that are not 'standard' are advanced dashboards, hidden initially. | boolean | |||
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] |