Skip to content

sensor_readouts

Returns the complete sensor readouts of executed checks on tables and columns.

get_column_monitoring_sensor_readouts

Returns a complete view of the sensor readouts for 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}/readouts

Return value

 Property name   Description                       Data type 
sensor_readouts_list_model List[SensorReadoutsListModel]

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 

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

get_column_partitioned_sensor_readouts

Returns a view of the sensor readouts for 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}/readouts

Return value

 Property name   Description                       Data type 
sensor_readouts_list_model List[SensorReadoutsListModel]

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 

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

get_column_profiling_sensor_readouts

Returns sensor results of the 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/readouts

Return value

 Property name   Description                       Data type 
sensor_readouts_list_model List[SensorReadoutsListModel]

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 

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

get_table_monitoring_sensor_readouts

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

Return value

 Property name   Description                       Data type 
sensor_readouts_list_model List[SensorReadoutsListModel]

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 

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

get_table_partitioned_sensor_readouts

Returns a complete view of sensor readouts for 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}/readouts

Return value

 Property name   Description                       Data type 
sensor_readouts_list_model List[SensorReadoutsListModel]

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 

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

get_table_profiling_sensor_readouts

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

Return value

 Property name   Description                       Data type 
sensor_readouts_list_model List[SensorReadoutsListModel]

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 

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