check_results
Returns the complete results of executed checks on tables and columns.
get_column_monitoring_checks_results
Returns a complete view of the recent column level monitoring executions for the monitoring at a requested time scale
Source code
GET
http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/monitoring/{timeScale}/results
Return value
| Property name | Description | Data type |
|---|---|---|
| check_results_list_model | List[CheckResultsListModel] |
Parameters of this method are described below
| Property name | Description | Data type | Required |
|---|---|---|---|
| connection_name | Connection name | string | |
| schema_name | Schema name | string | |
| table_name | Table name | string | |
| column_name | Column name | string | |
| time_scale | Time scale | CheckTimeScale | |
| data_group | Data group | string | |
| month_start | Month start boundary | string | |
| month_end | Month end boundary | string | |
| check_name | Check name | string | |
| category | Check category name | string | |
| table_comparison | Table comparison name | string | |
| max_results_per_check | Maximum number of results per check, the default is 100 | long |
Usage examples
get_column_partitioned_checks_results
Returns an overview of the most recent column level partitioned checks executions for a requested time scale
Source code
GET
http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/partitioned/{timeScale}/results
Return value
| Property name | Description | Data type |
|---|---|---|
| check_results_list_model | List[CheckResultsListModel] |
Parameters of this method are described below
| Property name | Description | Data type | Required |
|---|---|---|---|
| connection_name | Connection name | string | |
| schema_name | Schema name | string | |
| table_name | Table name | string | |
| column_name | Column name | string | |
| time_scale | Time scale | CheckTimeScale | |
| data_group | Data group | string | |
| month_start | Month start boundary | string | |
| month_end | Month end boundary | string | |
| check_name | Check name | string | |
| category | Check category name | string | |
| table_comparison | Table comparison name | string | |
| max_results_per_check | Maximum number of results per check, the default is 100 | long |
Usage examples
get_column_profiling_checks_results
Returns an overview of the most recent check executions for all column level data quality profiling checks on a column
Source code
GET
http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/profiling/results
Return value
| Property name | Description | Data type |
|---|---|---|
| check_results_list_model | List[CheckResultsListModel] |
Parameters of this method are described below
| Property name | Description | Data type | Required |
|---|---|---|---|
| connection_name | Connection name | string | |
| schema_name | Schema name | string | |
| table_name | Table name | string | |
| column_name | Column name | string | |
| data_group | Data group | string | |
| month_start | Month start boundary | string | |
| month_end | Month end boundary | string | |
| check_name | Check name | string | |
| category | Check category name | string | |
| table_comparison | Table comparison name | string | |
| max_results_per_check | Maximum number of results per check, the default is 100 | long |
Usage examples
get_table_data_quality_status
Read the most recent results of executed data quality checks on the table and return the current table's data quality status - the number of failed data quality checks if the table has active data quality issues. Also returns the names of data quality checks that did not pass most recently. This operation verifies only the status of the most recently executed data quality checks. Previous data quality issues are not counted.
Source code
GET
http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/status
Return value
| Property name | Description | Data type |
|---|---|---|
| table_current_data_quality_status_model | TableCurrentDataQualityStatusModel |
Parameters of this method are described below
| Property name | Description | Data type | Required |
|---|---|---|---|
| connection_name | Connection name | string | |
| schema_name | Schema name | string | |
| table_name | Table name | string | |
| months | Optional filter - the number of months to review the data quality check results. For partitioned checks, it is the number of months to analyze. The default value is 1 (which is the current month and 1 previous month). | long | |
| since | Optional filter that accepts an UTC timestamp to read only data quality check results captured since that timestamp. | long | |
| profiling | Optional check type filter to detect the current status of the profiling checks results. The default value is false, excluding profiling checks from the current table status detection. If enabled, only the status of the most recent check result is retrieved. | boolean | |
| monitoring | Optional check type filter to detect the current status of the monitoring checks results. The default value is true, including monitoring checks in the current table status detection. If enabled, only the status of the most recent check result is retrieved. | boolean | |
| partitioned | Optional check type filter to detect the current status of the partitioned checks results. The default value is true, including partitioned checks in the current table status detection. Detection of the status of partitioned checks is different. When enabled, DQOps checks the highest severity status of all partitions since the since date or within the last months. | boolean | |
| check_time_scale | Optional time scale filter for monitoring and partitioned checks (values: daily or monthly). | CheckTimeScale | |
| data_group | Optional data group | string | |
| check_name | Optional check name | string | |
| category | Optional check category name | string | |
| table_comparison | Optional table comparison name | string | |
| quality_dimension | Optional data quality dimension | string |
Usage examples
get_table_monitoring_checks_results
Returns the complete results of the most recent table level monitoring executions for the monitoring at a requested time scale
Source code
GET
http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/{timeScale}/results
Return value
| Property name | Description | Data type |
|---|---|---|
| check_results_list_model | List[CheckResultsListModel] |
Parameters of this method are described below
| Property name | Description | Data type | Required |
|---|---|---|---|
| connection_name | Connection name | string | |
| schema_name | Schema name | string | |
| table_name | Table name | string | |
| time_scale | Time scale | CheckTimeScale | |
| data_group | Data group | string | |
| month_start | Month start boundary | string | |
| month_end | Month end boundary | string | |
| check_name | Check name | string | |
| category | Check category name | string | |
| table_comparison | Table comparison name | string | |
| max_results_per_check | Maximum number of results per check, the default is 100 | long |
Usage examples
get_table_partitioned_checks_results
Returns a complete view of the recent table level partitioned checks executions for a requested time scale
Source code
GET
http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/{timeScale}/results
Return value
| Property name | Description | Data type |
|---|---|---|
| check_results_list_model | List[CheckResultsListModel] |
Parameters of this method are described below
| Property name | Description | Data type | Required |
|---|---|---|---|
| connection_name | Connection name | string | |
| schema_name | Schema name | string | |
| table_name | Table name | string | |
| time_scale | Time scale | CheckTimeScale | |
| data_group | Data group | string | |
| month_start | Month start boundary | string | |
| month_end | Month end boundary | string | |
| check_name | Check name | string | |
| category | Check category name | string | |
| table_comparison | Table comparison name | string | |
| max_results_per_check | Maximum number of results per check, the default is 100 | long |
Usage examples
get_table_profiling_checks_results
Returns the complete results of the most recent check executions for all table level data quality profiling checks on a table
Source code
GET
http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/profiling/results
Return value
| Property name | Description | Data type |
|---|---|---|
| check_results_list_model | List[CheckResultsListModel] |
Parameters of this method are described below
| Property name | Description | Data type | Required |
|---|---|---|---|
| connection_name | Connection name | string | |
| schema_name | Schema name | string | |
| table_name | Table name | string | |
| data_group | Data group | string | |
| month_start | Month start boundary | string | |
| month_end | Month end boundary | string | |
| check_name | Check name | string | |
| category | Check category name | string | |
| table_comparison | Table comparison name | string | |
| max_results_per_check | Maximum number of results per check, the default is 100 | long |
Usage examples