incidents
CheckResultEntryModel
Detailed results for a single check. Represent one row in the check results table.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
| id | Check result ID. | string |
| check_hash | Check hash. | long |
| check_category | Check category name. | string |
| check_name | Check name. | string |
| check_display_name | Check display name. | string |
| check_type | Check type. | string |
| actual_value | Actual value. | double |
| expected_value | Expected value. | double |
| warning_lower_bound | Warning lower bound. | double |
| warning_upper_bound | Warning upper bound. | double |
| error_lower_bound | Error lower bound. | double |
| error_upper_bound | Error upper bound. | double |
| fatal_lower_bound | Fatal lower bound. | double |
| fatal_upper_bound | Fatal upper bound. | double |
| severity | Severity. | integer |
| column_name | Column name. | string |
| data_group | Data group. | string |
| duration_ms | Duration (ms). | integer |
| time_gradient | Time gradient. | string |
| time_period | Time period. | datetime |
| include_in_kpi | Include in KPI. | boolean |
| include_in_sla | Include in SLA. | boolean |
| provider | Provider. | string |
| quality_dimension | Quality dimension. | string |
| sensor_name | Sensor name. | string |
| table_comparison | Table comparison name. | string |
CheckResultSortOrder
Enumeration of columns names on a {@link CheckResultEntryModel CheckResultEntryModel} that could be sorted.
The structure of this object is described below
| Data type | Enum values |
|---|---|
| string | checkType severity executedAt sensorName checkDisplayName actualValue checkCategory checkHash checkName dataGroup expectedValue timePeriod qualityDimension timeGradient columnName |
IncidentDailyIssuesCount
A model that stores a daily number of incidents.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
| warnings | The number of failed data quality checks that generated a warning severity data quality issue. | integer |
| errors | The number of failed data quality checks that generated an error severity data quality issue. | integer |
| fatals | The number of failed data quality checks that generated a fatal severity data quality issue. | integer |
| total_count | The total count of failed data quality checks on this day. | integer |
IncidentIssueHistogramModel
Model that returns histograms of the data quality issue occurrences related to a data quality incident. The dates in the daily histogram are using the default timezone of the DQOps server.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
| has_profiling_issues | True when this data quality incident is based on data quality issues from profiling checks within the filters applied to search for linked data quality issues. | boolean |
| has_monitoring_issues | True when this data quality incident is based on data quality issues from monitoring checks within the filters applied to search for linked data quality issues. | boolean |
| has_partitioned_issues | True when this data quality incident is based on data quality issues from partitioned checks within the filters applied to search for linked data quality issues. | boolean |
| days | A map of the numbers of data quality issues per day, the day uses the DQOps server timezone. | Dict[date, IncidentDailyIssuesCount] |
| columns | A map of column names with the most data quality issues related to the incident. The map returns the count of issues as the value. | Dict[string, integer] |
| checks | A map of data quality check names with the most data quality issues related to the incident. The map returns the count of issues as the value. | Dict[string, integer] |
IncidentStatus
Enumeration of the statuses used in the "status" field of the "incidents" table.
The structure of this object is described below
| Data type | Enum values |
|---|---|
| string | acknowledged muted open resolved |
IncidentModel
Data quality incident model shown on an incident details screen.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
| incident_id | Incident ID - the primary key that identifies each data quality incident. | string |
| connection | Connection name affected by a data quality incident. | string |
| year | The year when the incident was first seen. This value is required to load an incident's monthly partition. | integer |
| month | The month when the incident was first seen. This value is required to load an incident's monthly partition. | integer |
| 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 | The data group that was affected by a data quality incident. | 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 |
| minimum_severity | The minimum severity of the data quality incident, copied from the incident configuration at a connection or table at the time when the incident was first seen. 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. | IncidentStatus |
IncidentSortOrder
Incident sort order columns.
The structure of this object is described below
| Data type | Enum values |
|---|---|
| string | dataGroup lastSeen firstSeen tablePriority qualityDimension checkName failedChecksCount table highestSeverity |
IncidentsPerConnectionModel
Simple model that returns a list of connections and a number of open (new) data quality incidents per connection.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
| connection | Connection (data source) name. | string |
| open_incidents | Count of open (new) data quality incidents. | integer |
SortDirection
REST api model sort direction.
The structure of this object is described below
| Data type | Enum values |
|---|---|
| string | asc desc |