# Monitors

The Monitors API provides the building blocks to manage monitor discovery, execution, and results retrieval across assets and tenants.

{% hint style="info" %}
If you would like to view APIs related to managing monitors (create/update/delete), please refer to the [create-manage-and-delete](https://docs.decube.io/public-api/overview/index/monitors/create-manage-and-delete "mention") page.
{% endhint %}

## Post Search Monitors

> Search monitors with optional filters. Returns paginated results matching the specified criteria.

```json
{"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect.<REGION>.decube.io/api/v1/data"}],"paths":{"/monitors/search":{"post":{"tags":["Monitors"],"summary":"Post Search Monitors","description":"Search monitors with optional filters. Returns paginated results matching the specified criteria.","operationId":"post_search_monitors_monitors_search_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMonitorsBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorSummaryList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"SearchMonitorsBody":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","description":"Search term to match against name (substring match, case insensitive)"},"asset":{"anyOf":[{"$ref":"#/components/schemas/MonitorAssetIdentifier"},{"type":"null"}],"description":"Filter monitors that associated with a specific asset"},"children":{"type":"boolean","title":"Children","description":"If false, only return monitors directly associated with asset. Otherwise, return all monitors associated with asset and its children. This field is ignored if the asset is not present","default":false},"monitor_mode":{"anyOf":[{"$ref":"#/components/schemas/MonitorMode"},{"type":"null"}],"description":"Filter monitors by mode"},"test_type":{"anyOf":[{"$ref":"#/components/schemas/TestType"},{"type":"null"}],"description":"Filter monitors by the type of monitor"},"page":{"type":"integer","minimum":1,"title":"Page","default":1},"page_size":{"type":"integer","maximum":100,"minimum":1,"title":"Page Size","default":10}},"type":"object","title":"SearchMonitorsBody"},"MonitorAssetIdentifier":{"properties":{"type":{"type":"string","enum":["source","collection","dataset","property","data_job"],"title":"Type"},"id":{"type":"integer","minimum":0,"title":"Id","description":"Unique identifier of the monitor asset"}},"type":"object","required":["type","id"],"title":"MonitorAssetIdentifier"},"MonitorMode":{"type":"string","enum":["scheduled","on_demand"],"title":"MonitorMode"},"TestType":{"type":"string","enum":["volume","freshness","schema_drift","custom_sql","job_failure","null_percentage","not_null","is_unique","unique_percentage","cardinality","avg","min","max","string_length","is_email","is_uuid","regex_match","range","value_is","value_in","is_past_date","is_future_date","zero_percentage","negative_percentage","sum","null","unique","email","uuid","table_addition","table_deletion","column_addition","column_deletion","column_type_change"],"title":"TestType"},"MonitorSummaryList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MonitorSummary"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"MonitorSummaryList"},"MonitorSummary":{"properties":{"created_by":{"$ref":"#/components/schemas/Users"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"id":{"type":"integer","title":"Id"},"asset":{"$ref":"#/components/schemas/app__models__public__asset__AssetIdentifier"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"mode":{"$ref":"#/components/schemas/MonitorMode"},"incident_type":{"$ref":"#/components/schemas/IncidentType"},"incident_level":{"$ref":"#/components/schemas/IncidentLevel"},"test_type":{"$ref":"#/components/schemas/TestType"},"notify":{"type":"boolean","title":"Notify"},"enabled":{"type":"boolean","title":"Enabled"},"is_group_by":{"type":"boolean","title":"Is Group By"},"dimension":{"anyOf":[{"$ref":"#/components/schemas/Dimension"},{"type":"null"}]}},"type":"object","required":["created_by","created_at","id","asset","name","description","mode","incident_type","incident_level","test_type","notify","enabled","is_group_by","dimension"],"title":"MonitorSummary"},"Users":{"properties":{"email":{"type":"string","title":"Email"},"id":{"type":"string","title":"Id"}},"type":"object","required":["email","id"],"title":"Users"},"app__models__public__asset__AssetIdentifier":{"properties":{"id":{"type":"integer","minimum":0,"title":"Id","description":"Unique identifier of the specific asset"},"type":{"$ref":"#/components/schemas/AssetMetadataTypes","description":"Type of the specific asset"}},"type":"object","required":["id","type"],"title":"AssetIdentifier"},"AssetMetadataTypes":{"type":"string","enum":["source","collection","dataset","property","data_job","data_task","data_run","file","glossary","category","term","monitor","dashboard","report","chart","policy","policy_rule","data_domain","data_subdomain","data_product","data_asset","data_asset_property","data_contract"],"title":"AssetMetadataTypes"},"IncidentType":{"type":"string","enum":["freshness","volume","schema_drift","field_health","custom_sql","user_defined","job_failure"],"title":"IncidentType"},"IncidentLevel":{"type":"string","enum":["info","warning","critical"],"title":"IncidentLevel"},"Dimension":{"type":"string","enum":["accuracy","completeness","consistency","timeliness","uniqueness","validity","granularity","others"],"title":"Dimension"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Monitor

> Get a specific monitor by ID.

```json
{"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect.<REGION>.decube.io/api/v1/data"}],"paths":{"/monitors":{"get":{"tags":["Monitors"],"summary":"Get Monitor","description":"Get a specific monitor by ID.","operationId":"get_monitor_monitors_get","parameters":[{"name":"monitor_id","in":"query","required":true,"schema":{"type":"integer","minimum":1,"description":"Unique identifier of the monitor","title":"Monitor Id"},"description":"Unique identifier of the monitor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"MonitorObject":{"properties":{"created_by":{"$ref":"#/components/schemas/Users"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"id":{"type":"integer","title":"Id"},"asset":{"$ref":"#/components/schemas/app__models__public__asset__AssetIdentifier"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"mode":{"$ref":"#/components/schemas/MonitorMode"},"incident_type":{"$ref":"#/components/schemas/IncidentType"},"incident_level":{"$ref":"#/components/schemas/IncidentLevel"},"test_type":{"$ref":"#/components/schemas/TestType"},"notify":{"type":"boolean","title":"Notify"},"enabled":{"type":"boolean","title":"Enabled"},"is_group_by":{"type":"boolean","title":"Is Group By"},"dimension":{"anyOf":[{"$ref":"#/components/schemas/Dimension"},{"type":"null"}]},"last_run":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Run"},"last_run_status":{"anyOf":[{"$ref":"#/components/schemas/TestStatus"},{"type":"null"}]},"custom_alerts":{"anyOf":[{"additionalProperties":{"items":{"type":"string"},"type":"array"},"propertyNames":{"enum":["slack","email","teams_webhook"]},"type":"object"},{"type":"null"}],"title":"Custom Alerts"},"row_creation":{"anyOf":[{"$ref":"#/components/schemas/SqlExpressionMode"},{"$ref":"#/components/schemas/TimestampMode"},{"$ref":"#/components/schemas/AllRecordsMode"},{"type":"null"}],"title":"Row Creation"},"frequency":{"anyOf":[{"$ref":"#/components/schemas/HourModeFrequency"},{"$ref":"#/components/schemas/DailyModeFrequency"},{"$ref":"#/components/schemas/WeeklyModeFrequency"},{"$ref":"#/components/schemas/MonthlyModeFrequency"},{"type":"null"}],"title":"Frequency"},"lookback_period":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lookback Period"},"groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Groups"},"group_mapping":{"anyOf":[{"$ref":"#/components/schemas/GroupMapping"},{"type":"null"}]},"custom_sql":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Sql"},"total_row_count_query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Row Count Query"},"threshold":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/AutoThreshold"},{"$ref":"#/components/schemas/PercentageRange"},{"$ref":"#/components/schemas/AbsoluteRange"},{"$ref":"#/components/schemas/PositiveRange"},{"$ref":"#/components/schemas/AnyRange"}],"discriminator":{"propertyName":"type","mapping":{"absolute":"#/components/schemas/AbsoluteRange","any_range":"#/components/schemas/AnyRange","auto":"#/components/schemas/AutoThreshold","percentage":"#/components/schemas/PercentageRange","positive_range":"#/components/schemas/PositiveRange"}}},{"type":"null"}],"title":"Threshold"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value"}},"type":"object","required":["created_by","created_at","id","asset","name","description","mode","incident_type","incident_level","test_type","notify","enabled","is_group_by","dimension","last_run","last_run_status","custom_alerts","row_creation","frequency","lookback_period","groups","group_mapping","custom_sql","total_row_count_query","threshold","value"],"title":"MonitorObject"},"Users":{"properties":{"email":{"type":"string","title":"Email"},"id":{"type":"string","title":"Id"}},"type":"object","required":["email","id"],"title":"Users"},"app__models__public__asset__AssetIdentifier":{"properties":{"id":{"type":"integer","minimum":0,"title":"Id","description":"Unique identifier of the specific asset"},"type":{"$ref":"#/components/schemas/AssetMetadataTypes","description":"Type of the specific asset"}},"type":"object","required":["id","type"],"title":"AssetIdentifier"},"AssetMetadataTypes":{"type":"string","enum":["source","collection","dataset","property","data_job","data_task","data_run","file","glossary","category","term","monitor","dashboard","report","chart","policy","policy_rule","data_domain","data_subdomain","data_product","data_asset","data_asset_property","data_contract"],"title":"AssetMetadataTypes"},"MonitorMode":{"type":"string","enum":["scheduled","on_demand"],"title":"MonitorMode"},"IncidentType":{"type":"string","enum":["freshness","volume","schema_drift","field_health","custom_sql","user_defined","job_failure"],"title":"IncidentType"},"IncidentLevel":{"type":"string","enum":["info","warning","critical"],"title":"IncidentLevel"},"TestType":{"type":"string","enum":["volume","freshness","schema_drift","custom_sql","job_failure","null_percentage","not_null","is_unique","unique_percentage","cardinality","avg","min","max","string_length","is_email","is_uuid","regex_match","range","value_is","value_in","is_past_date","is_future_date","zero_percentage","negative_percentage","sum","null","unique","email","uuid","table_addition","table_deletion","column_addition","column_deletion","column_type_change"],"title":"TestType"},"Dimension":{"type":"string","enum":["accuracy","completeness","consistency","timeliness","uniqueness","validity","granularity","others"],"title":"Dimension"},"TestStatus":{"type":"string","enum":["running","passed","failed","skipped","no_data","errored"],"title":"TestStatus"},"SqlExpressionMode":{"properties":{"filter_mode":{"type":"string","const":"sql_expression","title":"Filter Mode"},"sql_expression":{"type":"string","title":"Sql Expression"},"enable_smart_training":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enable Smart Training"}},"type":"object","required":["filter_mode","sql_expression"],"title":"SqlExpressionMode"},"TimestampMode":{"properties":{"filter_mode":{"type":"string","const":"timestamp","title":"Filter Mode"},"metric_column_id":{"type":"integer","title":"Metric Column Id"},"enable_smart_training":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enable Smart Training"}},"type":"object","required":["filter_mode","metric_column_id"],"title":"TimestampMode"},"AllRecordsMode":{"properties":{"filter_mode":{"type":"string","const":"all_records","title":"Filter Mode"}},"type":"object","required":["filter_mode"],"title":"AllRecordsMode"},"HourModeFrequency":{"properties":{"frequency":{"type":"string","enum":["1H","3H","6H","12H"],"title":"Frequency"}},"type":"object","required":["frequency"],"title":"HourModeFrequency"},"DailyModeFrequency":{"properties":{"frequency":{"type":"string","const":"1D","title":"Frequency"},"time_of_day":{"type":"integer","title":"Time Of Day"},"timezone":{"type":"string","title":"Timezone"}},"type":"object","required":["frequency","time_of_day","timezone"],"title":"DailyModeFrequency"},"WeeklyModeFrequency":{"properties":{"frequency":{"type":"string","const":"7D","title":"Frequency"},"time_of_day":{"type":"integer","title":"Time Of Day"},"day_of_week":{"type":"integer","title":"Day Of Week"},"timezone":{"type":"string","title":"Timezone"}},"type":"object","required":["frequency","time_of_day","day_of_week","timezone"],"title":"WeeklyModeFrequency"},"MonthlyModeFrequency":{"properties":{"frequency":{"type":"string","const":"MS","title":"Frequency"},"time_of_day":{"type":"integer","title":"Time Of Day"},"day_of_month":{"type":"integer","title":"Day Of Month"},"timezone":{"type":"string","title":"Timezone"}},"type":"object","required":["frequency","time_of_day","day_of_month","timezone"],"title":"MonthlyModeFrequency"},"GroupMapping":{"properties":{"mapping_column_id":{"type":"integer","title":"Mapping Column Id"},"group_by_field_name":{"type":"string","title":"Group By Field Name"}},"type":"object","required":["mapping_column_id","group_by_field_name"],"title":"GroupMapping"},"AutoThreshold":{"properties":{"type":{"type":"string","const":"auto","title":"Type"}},"type":"object","required":["type"],"title":"AutoThreshold"},"PercentageRange":{"properties":{"type":{"type":"string","const":"percentage","title":"Type"},"min":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min"},"max":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max"}},"type":"object","required":["type","min","max"],"title":"PercentageRange"},"AbsoluteRange":{"properties":{"type":{"type":"string","const":"absolute","title":"Type"},"min":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min"},"max":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max"}},"type":"object","required":["type","min","max"],"title":"AbsoluteRange"},"PositiveRange":{"properties":{"type":{"type":"string","const":"positive_range","title":"Type"},"min":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min"},"max":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max"}},"type":"object","required":["type","min","max"],"title":"PositiveRange"},"AnyRange":{"properties":{"type":{"type":"string","const":"any_range","title":"Type"},"min":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min"},"max":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max"}},"type":"object","required":["type","min","max"],"title":"AnyRange"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Post Enable Disable Scheduled Monitor

> Enable, or disable a scheduled monitor.

```json
{"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect.<REGION>.decube.io/api/v1/data"}],"paths":{"/monitors/enable-disable":{"post":{"tags":["Monitors"],"summary":"Post Enable Disable Scheduled Monitor","description":"Enable, or disable a scheduled monitor.","operationId":"post_enable_disable_scheduled_monitor_monitors_enable_disable_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableDisableMonitorBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"EnableDisableMonitorBody":{"properties":{"monitor_id":{"type":"integer","minimum":1,"title":"Monitor Id","description":"Unique identifier of the monitor"},"enabled":{"type":"boolean","title":"Enabled"}},"type":"object","required":["monitor_id","enabled"],"title":"EnableDisableMonitorBody"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Monitor History

> Get a monitor's test result history in reverse chronological order (most recent first). For Schema Drift and Job Failure monitors, the endpoint returns only failing test results (i.e. when an incident is present). For all other monitor types, it returns the full history of results.

```json
{"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect.<REGION>.decube.io/api/v1/data"}],"paths":{"/monitors/history":{"get":{"tags":["Monitors"],"summary":"Get Monitor History","description":"Get a monitor's test result history in reverse chronological order (most recent first). For Schema Drift and Job Failure monitors, the endpoint returns only failing test results (i.e. when an incident is present). For all other monitor types, it returns the full history of results.","operationId":"get_monitor_history_monitors_history_get","parameters":[{"name":"monitor_id","in":"query","required":true,"schema":{"type":"integer","minimum":1,"description":"Unique identifier of the monitor","title":"Monitor Id"},"description":"Unique identifier of the monitor"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":10,"default":10,"title":"Page Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestResultList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"TestResultList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TestResult"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"TestResultList"},"TestResult":{"properties":{"status":{"$ref":"#/components/schemas/TestStatus"},"period":{"type":"string","format":"date-time","title":"Period"},"detail":{"anyOf":[{"$ref":"#/components/schemas/IsEmailTestDetail"},{"$ref":"#/components/schemas/IsUniqueTestDetail"},{"$ref":"#/components/schemas/NotNullTestDetail"},{"$ref":"#/components/schemas/ValueInTestDetail"},{"$ref":"#/components/schemas/ValueIsTestDetail"},{"$ref":"#/components/schemas/IsPastDateTestDetail"},{"$ref":"#/components/schemas/IsFutureDateTestDetail"},{"$ref":"#/components/schemas/IsUUIDTestDetail"},{"$ref":"#/components/schemas/RegexMatchTestDetail"},{"$ref":"#/components/schemas/AvgTestDetail"},{"$ref":"#/components/schemas/MaxTestDetail"},{"$ref":"#/components/schemas/MinTestDetail"},{"$ref":"#/components/schemas/SumTestDetail"},{"$ref":"#/components/schemas/NullTestDetail"},{"$ref":"#/components/schemas/UniqueTestDetail"},{"$ref":"#/components/schemas/EmailTestDetail"},{"$ref":"#/components/schemas/UUIDTestDetail"},{"$ref":"#/components/schemas/NullPercentageTestDetail"},{"$ref":"#/components/schemas/ZeroPercentageTestDetail"},{"$ref":"#/components/schemas/NegativePercentageTestDetail"},{"$ref":"#/components/schemas/UniquePercentageTestDetail"},{"$ref":"#/components/schemas/RangeTestDetail"},{"$ref":"#/components/schemas/StringLengthTestDetail"},{"$ref":"#/components/schemas/CardinalityTestDetail"},{"$ref":"#/components/schemas/FreshnessTestDetail"},{"$ref":"#/components/schemas/VolumeTestDetail"},{"$ref":"#/components/schemas/CustomSQLTestDetail"},{"$ref":"#/components/schemas/ColumnTypeChangeDetail"},{"$ref":"#/components/schemas/ColumnAdditionDetail"},{"$ref":"#/components/schemas/ColumnDeletionDetail"},{"$ref":"#/components/schemas/TableAdditionDetail"},{"$ref":"#/components/schemas/TableDeletionDetail"},{"type":"null"}],"title":"Detail"},"case_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Case Id","description":"This field only present if the status equals to 'failed'"},"incident_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Incident Id","description":"This field only present if the status equals to 'failed'"}},"type":"object","required":["status","period","detail","case_id","incident_id"],"title":"TestResult"},"TestStatus":{"type":"string","enum":["running","passed","failed","skipped","no_data","errored"],"title":"TestStatus"},"IsEmailTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"is_email","title":"Test Type"},"metric_name":{"type":"string","const":"not_email_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"IsEmailTestDetail"},"IsUniqueTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"is_unique","title":"Test Type"},"metric_name":{"type":"string","const":"unique_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"IsUniqueTestDetail"},"NotNullTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"not_null","title":"Test Type"},"metric_name":{"type":"string","const":"null_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"NotNullTestDetail"},"ValueInTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"value_in","title":"Test Type"},"metric_name":{"type":"string","const":"unmatched_value_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"ValueInTestDetail"},"ValueIsTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"value_is","title":"Test Type"},"metric_name":{"type":"string","const":"unmatched_value_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"ValueIsTestDetail"},"IsPastDateTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"is_past_date","title":"Test Type"},"metric_name":{"type":"string","const":"is_future_date_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"IsPastDateTestDetail"},"IsFutureDateTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"is_future_date","title":"Test Type"},"metric_name":{"type":"string","const":"is_past_date_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"IsFutureDateTestDetail"},"IsUUIDTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"is_uuid","title":"Test Type"},"metric_name":{"type":"string","const":"not_uuid_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"IsUUIDTestDetail"},"RegexMatchTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"regex_match","title":"Test Type"},"metric_name":{"type":"string","const":"not_regex_matched_count","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"RegexMatchTestDetail"},"AvgTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"avg","title":"Test Type"},"metric_name":{"type":"string","const":"avg","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"AvgTestDetail"},"MaxTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"max","title":"Test Type"},"metric_name":{"type":"string","const":"max","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"MaxTestDetail"},"MinTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"min","title":"Test Type"},"metric_name":{"type":"string","const":"min","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"MinTestDetail"},"SumTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"sum","title":"Test Type"},"metric_name":{"type":"string","const":"sum","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"SumTestDetail"},"NullTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"null","title":"Test Type"},"metric_name":{"type":"string","const":"null_count","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"NullTestDetail"},"UniqueTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"unique","title":"Test Type"},"metric_name":{"type":"string","const":"duplicate_count","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"UniqueTestDetail"},"EmailTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"email","title":"Test Type"},"metric_name":{"type":"string","const":"not_email_count","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"EmailTestDetail"},"UUIDTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"uuid","title":"Test Type"},"metric_name":{"type":"string","const":"not_uuid_count","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"UUIDTestDetail"},"NullPercentageTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"null_percentage","title":"Test Type"},"metric_name":{"type":"string","const":"null_percentage","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"NullPercentageTestDetail"},"ZeroPercentageTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"zero_percentage","title":"Test Type"},"metric_name":{"type":"string","const":"zero_percentage","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"ZeroPercentageTestDetail"},"NegativePercentageTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"negative_percentage","title":"Test Type"},"metric_name":{"type":"string","const":"negative_percentage","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"NegativePercentageTestDetail"},"UniquePercentageTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"unique_percentage","title":"Test Type"},"metric_name":{"type":"string","const":"unique_percentage","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"UniquePercentageTestDetail"},"RangeTestDetail":{"properties":{"value_min":{"type":"number","title":"Value Min"},"value_max":{"type":"number","title":"Value Max"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"range","title":"Test Type"},"metric_name_min":{"type":"string","const":"min","title":"Metric Name Min"},"metric_name_max":{"type":"string","const":"max","title":"Metric Name Max"}},"type":"object","required":["value_min","value_max","upper_bound","lower_bound","test_type","metric_name_min","metric_name_max"],"title":"RangeTestDetail"},"StringLengthTestDetail":{"properties":{"value_min":{"type":"number","title":"Value Min"},"value_max":{"type":"number","title":"Value Max"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"string_length","title":"Test Type"},"metric_name_min":{"type":"string","const":"matched_string_length_min","title":"Metric Name Min"},"metric_name_max":{"type":"string","const":"matched_string_length_max","title":"Metric Name Max"}},"type":"object","required":["value_min","value_max","upper_bound","lower_bound","test_type","metric_name_min","metric_name_max"],"title":"StringLengthTestDetail"},"CardinalityTestDetail":{"properties":{"test_type":{"type":"string","const":"cardinality","title":"Test Type"},"unique_count":{"type":"integer","title":"Unique Count"},"cardinality":{"type":"string","enum":["low","medium","high"],"title":"Cardinality"},"expected":{"type":"string","enum":["low","medium","high"],"title":"Expected"}},"type":"object","required":["test_type","unique_count","cardinality","expected"],"title":"CardinalityTestDetail"},"FreshnessTestDetail":{"properties":{"test_type":{"type":"string","const":"freshness","title":"Test Type"},"write_probability":{"type":"number","title":"Write Probability","description":"Probability of a write operation occurring, 0-1"},"time_since_last_write":{"type":"number","title":"Time Since Last Write","description":"Time in minutes since the last write operation"}},"type":"object","required":["test_type","write_probability","time_since_last_write"],"title":"FreshnessTestDetail"},"VolumeTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"volume","title":"Test Type"},"metric_name":{"type":"string","const":"row_count_incremental","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"VolumeTestDetail"},"CustomSQLTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"custom_sql","title":"Test Type"},"metric_name":{"type":"string","const":"custom","title":"Metric Name"},"row_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Row Count"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name","row_count"],"title":"CustomSQLTestDetail"},"ColumnTypeChangeDetail":{"properties":{"test_type":{"type":"string","const":"column_type_change","title":"Test Type"},"asset":{"$ref":"#/components/schemas/PropertyAssetObject"},"old_type":{"type":"string","title":"Old Type"},"new_type":{"type":"string","title":"New Type"}},"type":"object","required":["test_type","asset","old_type","new_type"],"title":"ColumnTypeChangeDetail"},"PropertyAssetObject":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"type":{"type":"string","const":"property","title":"Type"}},"type":"object","required":["id","name","type"],"title":"PropertyAssetObject"},"ColumnAdditionDetail":{"properties":{"test_type":{"type":"string","const":"column_addition","title":"Test Type"},"asset":{"$ref":"#/components/schemas/PropertyAssetObject"}},"type":"object","required":["test_type","asset"],"title":"ColumnAdditionDetail"},"ColumnDeletionDetail":{"properties":{"test_type":{"type":"string","const":"column_deletion","title":"Test Type"},"asset":{"$ref":"#/components/schemas/PropertyAssetObject"}},"type":"object","required":["test_type","asset"],"title":"ColumnDeletionDetail"},"TableAdditionDetail":{"properties":{"test_type":{"type":"string","const":"table_addition","title":"Test Type"},"asset":{"$ref":"#/components/schemas/DatasetAssetObject"}},"type":"object","required":["test_type","asset"],"title":"TableAdditionDetail"},"DatasetAssetObject":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"type":{"type":"string","const":"dataset","title":"Type"}},"type":"object","required":["id","name","type"],"title":"DatasetAssetObject"},"TableDeletionDetail":{"properties":{"test_type":{"type":"string","const":"table_deletion","title":"Test Type"},"asset":{"$ref":"#/components/schemas/DatasetAssetObject"}},"type":"object","required":["test_type","asset"],"title":"TableDeletionDetail"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Post Trigger On Demand Monitor

> Trigger an on-demand run for a monitor. Returns a UUID that can be used to track the execution status. Only one on-demand run can be active at a time per monitor. The monitor must be of a supported type (mode = on\_demand) and cannot be a schema drift or job failure monitor.

```json
{"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect.<REGION>.decube.io/api/v1/data"}],"paths":{"/monitors/trigger":{"post":{"tags":["Monitors"],"summary":"Post Trigger On Demand Monitor","description":"Trigger an on-demand run for a monitor. Returns a UUID that can be used to track the execution status. Only one on-demand run can be active at a time per monitor. The monitor must be of a supported type (mode = on_demand) and cannot be a schema drift or job failure monitor.","operationId":"post_trigger_on_demand_monitor_monitors_trigger_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerOnDemandMonitorBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerOnDemandMonitor"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"TriggerOnDemandMonitorBody":{"properties":{"monitor_id":{"type":"integer","minimum":1,"title":"Monitor Id","description":"Unique identifier of the monitor"}},"type":"object","required":["monitor_id"],"title":"TriggerOnDemandMonitorBody"},"TriggerOnDemandMonitor":{"properties":{"job_id":{"type":"string","format":"uuid","title":"Job Id"}},"type":"object","required":["job_id"],"title":"TriggerOnDemandMonitor"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Monitor Run Status

> Get the status of an on-demand monitor run. Returns the current status of the run and, if completed, the corresponding test result.

```json
{"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect.<REGION>.decube.io/api/v1/data"}],"paths":{"/monitors/status":{"get":{"tags":["Monitors"],"summary":"Get Monitor Run Status","description":"Get the status of an on-demand monitor run. Returns the current status of the run and, if completed, the corresponding test result.","operationId":"get_monitor_run_status_monitors_status_get","parameters":[{"name":"job_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","description":"Unique identifier of monitor run","title":"Job Id"},"description":"Unique identifier of monitor run"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorRunStatusResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"MonitorRunStatusResult":{"properties":{"status":{"$ref":"#/components/schemas/MonitorRunStatus"},"result":{"anyOf":[{"$ref":"#/components/schemas/TestResult"},{"type":"null"}]}},"type":"object","required":["status","result"],"title":"MonitorRunStatusResult"},"MonitorRunStatus":{"type":"string","enum":["running","queued","error","completed"],"title":"MonitorRunStatus"},"TestResult":{"properties":{"status":{"$ref":"#/components/schemas/TestStatus"},"period":{"type":"string","format":"date-time","title":"Period"},"detail":{"anyOf":[{"$ref":"#/components/schemas/IsEmailTestDetail"},{"$ref":"#/components/schemas/IsUniqueTestDetail"},{"$ref":"#/components/schemas/NotNullTestDetail"},{"$ref":"#/components/schemas/ValueInTestDetail"},{"$ref":"#/components/schemas/ValueIsTestDetail"},{"$ref":"#/components/schemas/IsPastDateTestDetail"},{"$ref":"#/components/schemas/IsFutureDateTestDetail"},{"$ref":"#/components/schemas/IsUUIDTestDetail"},{"$ref":"#/components/schemas/RegexMatchTestDetail"},{"$ref":"#/components/schemas/AvgTestDetail"},{"$ref":"#/components/schemas/MaxTestDetail"},{"$ref":"#/components/schemas/MinTestDetail"},{"$ref":"#/components/schemas/SumTestDetail"},{"$ref":"#/components/schemas/NullTestDetail"},{"$ref":"#/components/schemas/UniqueTestDetail"},{"$ref":"#/components/schemas/EmailTestDetail"},{"$ref":"#/components/schemas/UUIDTestDetail"},{"$ref":"#/components/schemas/NullPercentageTestDetail"},{"$ref":"#/components/schemas/ZeroPercentageTestDetail"},{"$ref":"#/components/schemas/NegativePercentageTestDetail"},{"$ref":"#/components/schemas/UniquePercentageTestDetail"},{"$ref":"#/components/schemas/RangeTestDetail"},{"$ref":"#/components/schemas/StringLengthTestDetail"},{"$ref":"#/components/schemas/CardinalityTestDetail"},{"$ref":"#/components/schemas/FreshnessTestDetail"},{"$ref":"#/components/schemas/VolumeTestDetail"},{"$ref":"#/components/schemas/CustomSQLTestDetail"},{"$ref":"#/components/schemas/ColumnTypeChangeDetail"},{"$ref":"#/components/schemas/ColumnAdditionDetail"},{"$ref":"#/components/schemas/ColumnDeletionDetail"},{"$ref":"#/components/schemas/TableAdditionDetail"},{"$ref":"#/components/schemas/TableDeletionDetail"},{"type":"null"}],"title":"Detail"},"case_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Case Id","description":"This field only present if the status equals to 'failed'"},"incident_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Incident Id","description":"This field only present if the status equals to 'failed'"}},"type":"object","required":["status","period","detail","case_id","incident_id"],"title":"TestResult"},"TestStatus":{"type":"string","enum":["running","passed","failed","skipped","no_data","errored"],"title":"TestStatus"},"IsEmailTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"is_email","title":"Test Type"},"metric_name":{"type":"string","const":"not_email_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"IsEmailTestDetail"},"IsUniqueTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"is_unique","title":"Test Type"},"metric_name":{"type":"string","const":"unique_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"IsUniqueTestDetail"},"NotNullTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"not_null","title":"Test Type"},"metric_name":{"type":"string","const":"null_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"NotNullTestDetail"},"ValueInTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"value_in","title":"Test Type"},"metric_name":{"type":"string","const":"unmatched_value_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"ValueInTestDetail"},"ValueIsTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"value_is","title":"Test Type"},"metric_name":{"type":"string","const":"unmatched_value_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"ValueIsTestDetail"},"IsPastDateTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"is_past_date","title":"Test Type"},"metric_name":{"type":"string","const":"is_future_date_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"IsPastDateTestDetail"},"IsFutureDateTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"is_future_date","title":"Test Type"},"metric_name":{"type":"string","const":"is_past_date_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"IsFutureDateTestDetail"},"IsUUIDTestDetail":{"properties":{"value":{"type":"integer","title":"Value"},"test_type":{"type":"string","const":"is_uuid","title":"Test Type"},"metric_name":{"type":"string","const":"not_uuid_count","title":"Metric Name"}},"type":"object","required":["value","test_type","metric_name"],"title":"IsUUIDTestDetail"},"RegexMatchTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"regex_match","title":"Test Type"},"metric_name":{"type":"string","const":"not_regex_matched_count","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"RegexMatchTestDetail"},"AvgTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"avg","title":"Test Type"},"metric_name":{"type":"string","const":"avg","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"AvgTestDetail"},"MaxTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"max","title":"Test Type"},"metric_name":{"type":"string","const":"max","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"MaxTestDetail"},"MinTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"min","title":"Test Type"},"metric_name":{"type":"string","const":"min","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"MinTestDetail"},"SumTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"sum","title":"Test Type"},"metric_name":{"type":"string","const":"sum","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"SumTestDetail"},"NullTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"null","title":"Test Type"},"metric_name":{"type":"string","const":"null_count","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"NullTestDetail"},"UniqueTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"unique","title":"Test Type"},"metric_name":{"type":"string","const":"duplicate_count","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"UniqueTestDetail"},"EmailTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"email","title":"Test Type"},"metric_name":{"type":"string","const":"not_email_count","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"EmailTestDetail"},"UUIDTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"uuid","title":"Test Type"},"metric_name":{"type":"string","const":"not_uuid_count","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"UUIDTestDetail"},"NullPercentageTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"null_percentage","title":"Test Type"},"metric_name":{"type":"string","const":"null_percentage","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"NullPercentageTestDetail"},"ZeroPercentageTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"zero_percentage","title":"Test Type"},"metric_name":{"type":"string","const":"zero_percentage","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"ZeroPercentageTestDetail"},"NegativePercentageTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"negative_percentage","title":"Test Type"},"metric_name":{"type":"string","const":"negative_percentage","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"NegativePercentageTestDetail"},"UniquePercentageTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"unique_percentage","title":"Test Type"},"metric_name":{"type":"string","const":"unique_percentage","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"UniquePercentageTestDetail"},"RangeTestDetail":{"properties":{"value_min":{"type":"number","title":"Value Min"},"value_max":{"type":"number","title":"Value Max"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"range","title":"Test Type"},"metric_name_min":{"type":"string","const":"min","title":"Metric Name Min"},"metric_name_max":{"type":"string","const":"max","title":"Metric Name Max"}},"type":"object","required":["value_min","value_max","upper_bound","lower_bound","test_type","metric_name_min","metric_name_max"],"title":"RangeTestDetail"},"StringLengthTestDetail":{"properties":{"value_min":{"type":"number","title":"Value Min"},"value_max":{"type":"number","title":"Value Max"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"string_length","title":"Test Type"},"metric_name_min":{"type":"string","const":"matched_string_length_min","title":"Metric Name Min"},"metric_name_max":{"type":"string","const":"matched_string_length_max","title":"Metric Name Max"}},"type":"object","required":["value_min","value_max","upper_bound","lower_bound","test_type","metric_name_min","metric_name_max"],"title":"StringLengthTestDetail"},"CardinalityTestDetail":{"properties":{"test_type":{"type":"string","const":"cardinality","title":"Test Type"},"unique_count":{"type":"integer","title":"Unique Count"},"cardinality":{"type":"string","enum":["low","medium","high"],"title":"Cardinality"},"expected":{"type":"string","enum":["low","medium","high"],"title":"Expected"}},"type":"object","required":["test_type","unique_count","cardinality","expected"],"title":"CardinalityTestDetail"},"FreshnessTestDetail":{"properties":{"test_type":{"type":"string","const":"freshness","title":"Test Type"},"write_probability":{"type":"number","title":"Write Probability","description":"Probability of a write operation occurring, 0-1"},"time_since_last_write":{"type":"number","title":"Time Since Last Write","description":"Time in minutes since the last write operation"}},"type":"object","required":["test_type","write_probability","time_since_last_write"],"title":"FreshnessTestDetail"},"VolumeTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"volume","title":"Test Type"},"metric_name":{"type":"string","const":"row_count_incremental","title":"Metric Name"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name"],"title":"VolumeTestDetail"},"CustomSQLTestDetail":{"properties":{"value":{"type":"number","title":"Value"},"upper_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper Bound"},"lower_bound":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower Bound"},"test_type":{"type":"string","const":"custom_sql","title":"Test Type"},"metric_name":{"type":"string","const":"custom","title":"Metric Name"},"row_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Row Count"}},"type":"object","required":["value","upper_bound","lower_bound","test_type","metric_name","row_count"],"title":"CustomSQLTestDetail"},"ColumnTypeChangeDetail":{"properties":{"test_type":{"type":"string","const":"column_type_change","title":"Test Type"},"asset":{"$ref":"#/components/schemas/PropertyAssetObject"},"old_type":{"type":"string","title":"Old Type"},"new_type":{"type":"string","title":"New Type"}},"type":"object","required":["test_type","asset","old_type","new_type"],"title":"ColumnTypeChangeDetail"},"PropertyAssetObject":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"type":{"type":"string","const":"property","title":"Type"}},"type":"object","required":["id","name","type"],"title":"PropertyAssetObject"},"ColumnAdditionDetail":{"properties":{"test_type":{"type":"string","const":"column_addition","title":"Test Type"},"asset":{"$ref":"#/components/schemas/PropertyAssetObject"}},"type":"object","required":["test_type","asset"],"title":"ColumnAdditionDetail"},"ColumnDeletionDetail":{"properties":{"test_type":{"type":"string","const":"column_deletion","title":"Test Type"},"asset":{"$ref":"#/components/schemas/PropertyAssetObject"}},"type":"object","required":["test_type","asset"],"title":"ColumnDeletionDetail"},"TableAdditionDetail":{"properties":{"test_type":{"type":"string","const":"table_addition","title":"Test Type"},"asset":{"$ref":"#/components/schemas/DatasetAssetObject"}},"type":"object","required":["test_type","asset"],"title":"TableAdditionDetail"},"DatasetAssetObject":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"type":{"type":"string","const":"dataset","title":"Type"}},"type":"object","required":["id","name","type"],"title":"DatasetAssetObject"},"TableDeletionDetail":{"properties":{"test_type":{"type":"string","const":"table_deletion","title":"Test Type"},"asset":{"$ref":"#/components/schemas/DatasetAssetObject"}},"type":"object","required":["test_type","asset"],"title":"TableDeletionDetail"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.decube.io/public-api/overview/index/monitors.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.