Skip to content

check_results_overview

Returns the overview of the recently executed checks on tables and columns.

get_column_monitoring_checks_overview

Returns an overview of the most 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}/overview

Return value

 Property name   Description                       Data type 
check_results_overview_data_model List[CheckResultsOverviewDataModel]

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

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/monitoring/"daily"/overview^
    -H "Accept: application/json"

get_column_partitioned_checks_overview

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}/overview

Return value

 Property name   Description                       Data type 
check_results_overview_data_model List[CheckResultsOverviewDataModel]

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

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/partitioned/"daily"/overview^
    -H "Accept: application/json"

get_column_profiling_checks_overview

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/overview

Return value

 Property name   Description                       Data type 
check_results_overview_data_model List[CheckResultsOverviewDataModel]

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

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/profiling/overview^
    -H "Accept: application/json"

get_table_monitoring_checks_overview

Returns an overview 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}/overview

Return value

 Property name   Description                       Data type 
check_results_overview_data_model List[CheckResultsOverviewDataModel]

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

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/"daily"/overview^
    -H "Accept: application/json"

get_table_partitioned_checks_overview

Returns an overview of the most 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}/overview

Return value

 Property name   Description                       Data type 
check_results_overview_data_model List[CheckResultsOverviewDataModel]

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

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/"daily"/overview^
    -H "Accept: application/json"

get_table_profiling_checks_overview

Returns an overview 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/overview

Return value

 Property name   Description                       Data type 
check_results_overview_data_model List[CheckResultsOverviewDataModel]

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

Usage examples 

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/profiling/overview^
    -H "Accept: application/json"