Last updated: August 20, 2024

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.

IncidentNotificationMessage

Notification message payload that is posted (HTTP POST) to a notification endpoint with the details of a new or updated data quality incident.

The structure of this object is described below

Property name	Description	Data type	Enum values	Default value	Sample values
incident_id	Incident ID - the primary key that identifies each data quality incident.	string
connection	Connection name affected by a data quality incident.	string
schema	Schema name affected by a data quality incident.	string
table	Table name affected by a data quality incident.	string
table_priority	Table priority of the table that was affected by a data quality incident.	integer
incident_hash	Data quality incident hash that identifies similar incidents on the same incident grouping level.	long
data_group_name	The data group name that was affected by a data quality incident. The data group names are created from the values of columns and tags configured in the data grouping configuration. An example data group when grouping a static tag "customers" as the first level grouping and a country column value for the second grouping level is customers / UK.	string
quality_dimension	The data quality dimension that was affected by a data quality incident.	string
check_category	The data quality check category that was affected by a data quality incident.	string
check_type	The data quality check type that was affected by a data quality incident.	string
check_name	The data quality check name that was affected by a data quality incident.	string
highest_severity	The highest failed check severity that was detected as part of this data quality incident. Possible values are: 1 - warning, 2 - error, 3 - fatal.	integer
failed_checks_count	The total number of failed data quality checks that were seen when the incident was raised for the first time.	integer
issue_url	The link (url) to a ticket in an external system that is tracking this incident.	string
status	Incident status.	enum	open acknowledged resolved muted
message	Message with the details of the filtered notification such as purpose explanation, SLA note, etc.	string
text	Notification text that contains the most important fields from the class.	string

---