Skip to content

Last updated: July 22, 2025

DQOps REST API incidents models reference

The references of all objects used by incidents REST API operations are listed below.

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 primary key string
check_hash Check hash, do not set a value when writing results to DQOps long
check_category Check category name string
check_name Check name string
check_display_name Check display name string
check_type Check type CheckType
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 Issue severity, 0 - valid, 1 - warning, 2 - error, 3 - fatal integer
column_name Column name string
data_group Data group name string
duration_ms Duration (ms) integer
time_gradient Time gradient TimePeriodGradient
time_period Time period datetime
include_in_kpi Include in KPI boolean
include_in_sla Include in SLA boolean
provider Provider name string
quality_dimension Data 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 can be sorted.

The structure of this object is described below

 Data type   Enum values 
string executedAt
checkHash
checkCategory
checkName
checkDisplayName
checkType
actualValue
expectedValue
severity
columnName
dataGroup
timeGradient
timePeriod
qualityDimension
sensorName
updatedAt

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 open
acknowledged
resolved
muted

IncidentFilteredNotificationLocation

Enumeration that says where a filtered notification for an incident is defined. Is it defined on a connection level, or on the global level.

The structure of this object is described below

 Data type   Enum values 
string connection
global

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
notification_name Matching filtered notification for this incident. string
notification_location If this incident has a matching filtered notification, this field will tell whether the filtered notification is defined on a connection level, or a global level. IncidentFilteredNotificationLocation

IncidentSortOrder

Incident sort order columns.

The structure of this object is described below

 Data type   Enum values 
string table
tablePriority
firstSeen
lastSeen
dataGroup
qualityDimension
checkName
highestSeverity
failedChecksCount

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

TopIncidentGrouping

Enumeration of groupings for incidents.

The structure of this object is described below

 Data type   Enum values 
string dimension
category
connection

IncidentCountsModel

Stores numbers of incidents over a specific time period.

The structure of this object is described below

 Property name   Description                       Data type 
total_count Number of incidents in total. integer
count_from_last24h Number of incidents from the last 24h from now. integer
count_from_last7days Number of incidents from the last 7 days, the number of 7 * 24 hours from now. integer
current_month_count Number of incidents from the complete current month. integer
current_month_date The first day of the current month date. date
previous_month_count Number of incidents from the complete previous month. integer
previous_month_date The first day of the previous month date. date

IncidentSeverityLevelCountsModel

Contains the counts for each of severity level.

The structure of this object is described below

 Property name   Description                       Data type 
warning_counts Counts for the warning severity level. IncidentCountsModel
error_counts Counts for the error severity level. IncidentCountsModel
fatal_counts Counts for the fatal severity level. IncidentCountsModel

TopIncidentsModel

Summary model with the most recent incidents grouped by one attribute (data quality dimension, data quality check category, etc).

The structure of this object is described below

 Property name   Description                       Data type 
grouping Incident grouping used to group the top incidents in the dictionary of top incidents. TopIncidentGrouping
status Incident status of the incidents that are returned. IncidentStatus
top_incidents Dictionary of the top incidents, grouped by the grouping such as the data quality dimension or a data quality check category. The incidents are sorted by the first seen descending (the most recent first). Dict[string, List[IncidentModel]]
open_incident_severity_level_counts Incident severity level count container for the incident with open status. IncidentSeverityLevelCountsModel
acknowledged_incident_severity_level_counts Incident severity level count container for the incident with acknowledged status. IncidentSeverityLevelCountsModel