Validates an anomaly detection detector Added in 5.4.0
Body Required
-
by_field_name string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
custom_rules array[object]
Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.
-
detector_description string
A description of the detector.
-
detector_index number
A unique identifier for the detector. This identifier is based on the order of the detectors in the
analysis_config
, starting at zero. If you specify a value for this property, it is ignored. -
exclude_frequent string
Values are
all
,none
,by
, orover
. -
field_name string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
function string
The analysis function that is used. For example,
count
,rare
,mean
,min
,max
, orsum
. -
over_field_name string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
partition_field_name string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
use_null boolean
Defines whether a new series is used as the null series when there is no value for the by or partition fields.
curl \
-X POST http://api.example.com/_ml/anomaly_detectors/_validate/detector \
-H "Content-Type: application/json" \
-d '{"by_field_name":"string","custom_rules":[{"actions":["skip_result"],"conditions":[{"applies_to":"actual","operator":"gt","value":42.0}],"scope":{"additionalProperty1":{"filter_id":"string","filter_type":"include"},"additionalProperty2":{"filter_id":"string","filter_type":"include"}}}],"detector_description":"string","detector_index":42.0,"exclude_frequent":"all","field_name":"string","function":"string","over_field_name":"string","partition_field_name":"string","use_null":true}'
{
"by_field_name": "string",
"custom_rules": [
{
"actions": [
"skip_result"
],
"conditions": [
{
"applies_to": "actual",
"operator": "gt",
"value": 42.0
}
],
"scope": {
"additionalProperty1": {
"filter_id": "string",
"filter_type": "include"
},
"additionalProperty2": {
"filter_id": "string",
"filter_type": "include"
}
}
}
],
"detector_description": "string",
"detector_index": 42.0,
"exclude_frequent": "all",
"field_name": "string",
"function": "string",
"over_field_name": "string",
"partition_field_name": "string",
"use_null": true
}
{
"acknowledged": true
}