Inspection Statuses¶

Inspection statuses report the result of each inspected day per project, data source and dataset. Authentication, pagination and errors are described in the Overview.

Method	Path	Description
`GET`	`/v1/inspection-statuses/data-sets`	Get data set inspection statuses
`GET`	`/v1/inspection-statuses/data-sources`	Get data source inspection statuses
`GET`	`/v1/inspection-statuses/projects`	Get project inspection statuses

Get data set inspection statuses¶

GET /v1/inspection-statuses/data-sets

Parameters

Name	In	Type	Required	Description
`data_source_id`	query	integer	Yes	Filter by data source ID
`dataset_id`	query	integer	No	Filter by data set ID
`start_date`	query	string	Yes	Start date (YYYY-MM-DD)
`end_date`	query	string	Yes	End date (YYYY-MM-DD)
`data_volume_status`	query	integer	No	Filter by data volume status
`data_anomaly_status`	query	integer	No	Filter by data anomaly status
`data_validation_status`	query	integer	No	Filter by data validation status
`data_analytics_status`	query	integer	No	Filter by data analytics status
`inspection_status`	query	integer	No	Filter by inspection status
`limit`	query	integer	No	Maximum number of rows to return (default: 200, max: 5000)

Responses

Status	Description	Body
`200`	Get data set inspection statuses	array of DatasetInspectionStatus
`400`	Invalid limit	ApiError
`401`	Not authenticated	ApiError
`500`	Internal error	ApiError

Example

curl -X GET 'https://digna.example.com/v1/inspection-statuses/data-sets?data_source_id=<data_source_id>&start_date=<start_date>&end_date=<end_date>' \
  -H "Authorization: Bearer $DIGNA_API_KEY"

Get data source inspection statuses¶

GET /v1/inspection-statuses/data-sources

Parameters

Name	In	Type	Required	Description
`project_id`	query	integer	No	Filter by project ID
`data_source_id`	query	integer	No	Filter by data source ID
`start_date`	query	string	Yes	Start date (YYYY-MM-DD)
`end_date`	query	string	Yes	End date (YYYY-MM-DD)
`data_source_name_like`	query	string	No	Filter by data source name
`is_inspected`	query	boolean	No	Filter by inspected state
`data_anomaly_status`	query	integer	No	Filter by data anomaly status
`data_volume_status`	query	integer	No	Filter by data volume status
`data_validation_status`	query	integer	No	Filter by data validation status
`data_analytics_status`	query	integer	No	Filter by data analytics status
`inspection_status`	query	integer	No	Filter by inspection status
`limit`	query	integer	No	Maximum number of rows to return (default: 200, max: 5000)

Responses

Status	Description	Body
`200`	Get data source inspection statuses	array of DataSourceInspectionStatus
`400`	Invalid limit	ApiError
`401`	Not authenticated	ApiError
`500`	Internal error	ApiError

Example

curl -X GET 'https://digna.example.com/v1/inspection-statuses/data-sources?start_date=<start_date>&end_date=<end_date>' \
  -H "Authorization: Bearer $DIGNA_API_KEY"

Get project inspection statuses¶

GET /v1/inspection-statuses/projects

Parameters

Name	In	Type	Required	Description
`project_id`	query	integer	Yes	Project ID
`start_date`	query	string	Yes	Start date (YYYY-MM-DD)
`end_date`	query	string	Yes	End date (YYYY-MM-DD)
`limit`	query	integer	No	Maximum number of rows to return (default: 200, max: 5000)

Responses

Status	Description	Body
`200`	Get project inspection statuses	array of ProjectInspectionStatus
`400`	Invalid limit	ApiError
`401`	Not authenticated	ApiError
`500`	Internal error	ApiError

Example

curl -X GET 'https://digna.example.com/v1/inspection-statuses/projects?project_id=<project_id>&start_date=<start_date>&end_date=<end_date>' \
  -H "Authorization: Bearer $DIGNA_API_KEY"

Schemas¶

ApiError¶

Field	Type	Required	Description
`code`	ApiErrorCode	Yes
`message`	string	Yes

DatasetInspectionStatus¶

Field	Type	Required
`data_analytics_status`	DatasetInspectionStatusDataAnalyticsStatus, nullable	No
`data_anomaly_status`	DatasetInspectionStatusDataAnomalyStatus, nullable	No
`data_source`	DatasetInspectionStatusDataSource	Yes
`data_validation_status`	DatasetInspectionStatusDataValidationStatus, nullable	No
`data_volume_status`	DatasetInspectionStatusDataVolumeStatus, nullable	No
`dataset`	DatasetInspectionStatusDataset	Yes
`dataset_definition`	DatasetInspectionStatusDatasetDefinition	Yes
`project`	DatasetInspectionStatusProject	Yes
`status`	InspectionStatus	Yes
`valid_date`	string (date)	Yes

DataSourceInspectionStatus¶

Field	Type	Required	Description
`data_analytics_status`	DataSourceInspectionStatusDataAnalyticsDataSourceStatus, nullable	No
`data_anomaly_status`	DataSourceInspectionStatusDataAnomalyStatus, nullable	No
`data_source`	DataSourceInspectionStatusDataSource	Yes
`data_validation_status`	DataSourceInspectionStatusDataValidationStatus, nullable	No
`data_volume_status`	DataSourceInspectionStatusDataVolumeStatus, nullable	No
`inspected_at`	string (date-time), nullable	No
`is_analyzed`	boolean	Yes	Whether someone has marked this date as reviewed.
`is_anomaly`	boolean	Yes	Whether someone has marked this date as a known anomaly, which keeps its error out of the data anomaly alert bound.
`is_inspected`	boolean	Yes
`project`	DataSourceInspectionStatusProject	Yes
`row_count`	integer, nullable	No	Rows the data source held on `valid_date`, `None` for a date it was not profiled on.
`status`	InspectionStatus	Yes
`valid_date`	string (date)	Yes

ProjectInspectionStatus¶

Field	Type	Required
`project`	ProjectInspectionStatusProject	Yes
`status`	InspectionStatus	Yes
`valid_date`	string (date)	Yes

ApiErrorCode¶

One of: INTERNAL_ERROR, INVALID_CREDENTIALS, NOT_FOUND, NOT_AUTHENTICATED, NOT_AUTHORIZED, INVALID_LICENSE, BAD_REQUEST.

DatasetInspectionStatusDataSource¶

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes

DatasetInspectionStatusDataset¶

Field	Type	Required
`full_name`	string	Yes
`id`	integer	Yes
`name`	string	Yes

DatasetInspectionStatusDatasetDefinition¶

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes

DatasetInspectionStatusProject¶

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes

InspectionStatus¶

One of: -1 (no status), 0 (OK), 1 (warning), 2 (critical).

DataSourceInspectionStatusDataSource¶

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes

DataSourceInspectionStatusProject¶

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes

ProjectInspectionStatusProject¶

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes

DatasetInspectionStatusDataAnalyticsStatus¶

Field	Type	Required
`num_failed`	integer	Yes
`num_not_relevant`	integer	Yes
`num_passed`	integer	Yes
`status`	TestStatus	Yes

DatasetInspectionStatusDataAnomalyStatus¶

Field	Type	Required
`num_checks`	integer	Yes
`num_failed`	integer	Yes
`num_passed`	integer	Yes
`num_uncertain`	integer	Yes
`status`	TestStatus	Yes

DatasetInspectionStatusDataValidationStatus¶

Field	Type	Required
`num_failed`	integer	Yes
`num_passed`	integer	Yes
`num_uncertain`	integer	Yes
`status`	TestStatus	Yes

DatasetInspectionStatusDataVolumeStatus¶

Field	Type	Required	Description
`row_count`	integer	Yes
`status`	TestStatus	Yes

DataSourceInspectionStatusDataAnalyticsDataSourceStatus¶

Field	Type	Required
`num_failed`	integer	Yes
`num_not_relevant`	integer	Yes
`num_passed`	integer	Yes
`status`	TestStatus	Yes

DataSourceInspectionStatusDataAnomalyStatus¶

Field	Type	Required
`num_checks`	integer	Yes
`num_failed`	integer	Yes
`num_passed`	integer	Yes
`num_uncertain`	integer	Yes
`status`	TestStatus	Yes

DataSourceInspectionStatusDataValidationStatus¶

Field	Type	Required
`num_failed`	integer	Yes
`num_passed`	integer	Yes
`num_uncertain`	integer	Yes
`status`	TestStatus	Yes

DataSourceInspectionStatusDataVolumeStatus¶

Field	Type	Required
`num_checks`	integer	Yes
`num_failed`	integer	Yes
`num_passed`	integer	Yes
`status`	TestStatus	Yes

TestStatus¶

One of: -1 (not tested), 0 (passed), 1 (uncertain), 2 (failed).