Skip to content

incidents

Data quality incidents controller that supports loading incidents and changing the status of an incident.

find_connection_incident_stats

Returns a list of connection names with incident statistics - the count of recent open incidents.
Source code

GET 

http://localhost:8888/api/incidentstat

Return value

 Property name   Description                       Data type 
incidents_per_connection_model List[IncidentsPerConnectionModel]

Usage examples 

curl http://localhost:8888/api/incidentstat^
    -H "Accept: application/json"

find_recent_incidents_on_connection

Returns a list of recent data quality incidents.
Source code

GET 

http://localhost:8888/api/incidents/{connectionName}

Return value

 Property name   Description                       Data type 
incident_model List[IncidentModel]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
months Number of recent months to load, the default is 3 months long
open Returns open incidents, when the parameter is missing, the default value is true boolean
acknowledged Returns acknowledged incidents, when the parameter is missing, the default value is true boolean
resolved Returns resolved incidents, when the parameter is missing, the default value is false boolean
muted Returns muted incidents, when the parameter is missing, the default value is false boolean
page Page number, the first page is 1 long
limit Page size, the default is 50 rows long
filter Optional full text search filter that supports prefix, suffix and nest*ed filter expressions string
order Optional sort order, the default sort order is by the number of failed data quality checks IncidentSortOrder
direction Optional sort direction, the default sort direction is ascending SortDirection

Usage examples 

curl http://localhost:8888/api/incidents/sample_connection^
    -H "Accept: application/json"

get_incident

Return a single data quality incident's details.
Source code

GET 

http://localhost:8888/api/incidents/{connectionName}/{year}/{month}/{incidentId}

Return value

 Property name   Description                       Data type 
incident_model IncidentModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
year Year when the incident was first seen long
month Month when the incident was first seen long
incident_id Incident id string

Usage examples 

curl http://localhost:8888/api/incidents/sample_connection/2007/10/sample_incident^
    -H "Accept: application/json"

get_incident_histogram

Generates histograms of data quality issues for each day, returning the number of data quality issues on that day. The other histograms are by a column name and by a check name.
Source code

GET 

http://localhost:8888/api/incidents/{connectionName}/{year}/{month}/{incidentId}/histogram

Return value

 Property name   Description                       Data type 
incident_issue_histogram_model IncidentIssueHistogramModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
year Year when the incident was first seen long
month Month when the incident was first seen long
incident_id Incident id string
filter Optional full text search filter that supports prefix, suffix and nest*ed filter expressions string
days Optional filter for a number of recent days to read the related issues long
date Optional date filter string
column Optional column name filter string
check Optional check name filter string

Usage examples 

curl http://localhost:8888/api/incidents/sample_connection/2007/10/sample_incident/histogram^
    -H "Accept: application/json"

get_incident_issues

Return a paged list of failed data quality check results that are related to an incident.
Source code

GET 

http://localhost:8888/api/incidents/{connectionName}/{year}/{month}/{incidentId}/issues

Return value

 Property name   Description                       Data type 
check_result_entry_model List[CheckResultEntryModel]

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
year Year when the incident was first seen long
month Month when the incident was first seen long
incident_id Incident id string
page Page number, the first page is 1 long
limit Page size, the default is 50 rows long
filter Optional filter string
days Optional filter for a number of recent days to read the related issues long
date Optional filter to return data quality issues only for a given date. The date should be an ISO8601 formatted date, it is treated as the timezone of the DQOps server. string
column Optional column name filter string
check Optional check name filter string
order Optional sort order, the default sort order is by the execution date CheckResultSortOrder
direction Optional sort direction, the default sort direction is ascending SortDirection

Usage examples 

curl http://localhost:8888/api/incidents/sample_connection/2007/10/sample_incident/issues^
    -H "Accept: application/json"

set_incident_issue_url

Changes the incident's issueUrl to a new status.
Source code

POST 

http://localhost:8888/api/incidents/{connectionName}/{year}/{month}/{incidentId}/issueurl

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
year Year when the incident was first seen long
month Month when the incident was first seen long
incident_id Incident id string
issue_url New incident's issueUrl string

Usage examples 

curl -X POST http://localhost:8888/api/incidents/sample_connection/2007/10/sample_incident/issueurl^
    -H "Accept: application/json"

set_incident_status

Changes the incident's status to a new status.
Source code

POST 

http://localhost:8888/api/incidents/{connectionName}/{year}/{month}/{incidentId}/status

Parameters of this method are described below

 Property name   Description                       Data type   Required 
connection_name Connection name string
year Year when the incident was first seen long
month Month when the incident was first seen long
incident_id Incident id string
status New incident status, supported values: open, acknowledged, resolved, muted IncidentStatus

Usage examples 

curl -X POST http://localhost:8888/api/incidents/sample_connection/2007/10/sample_incident/status^
    -H "Accept: application/json"