|
@@ -38,15 +38,17 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
|
|
(Optional, string) The timestamp of a single bucket result. If you do not
|
|
|
specify this parameter, the API returns information about all buckets.
|
|
|
|
|
|
-[[ml-get-bucket-request-body]]
|
|
|
-== {api-request-body-title}
|
|
|
+
|
|
|
+[[ml-get-bucket-query-parms]]
|
|
|
+== {api-query-parms-title}
|
|
|
|
|
|
`anomaly_score`::
|
|
|
(Optional, double) Returns buckets with anomaly scores greater or equal than
|
|
|
this value. Defaults to `0.0`.
|
|
|
|
|
|
`desc`::
|
|
|
-(Optional, Boolean) If true, the buckets are sorted in descending order. Defaults to `false`.
|
|
|
+(Optional, Boolean) If true, the buckets are sorted in descending order.
|
|
|
+Defaults to `false`.
|
|
|
|
|
|
`end`::
|
|
|
(Optional, string) Returns buckets with timestamps earlier than this time.
|
|
@@ -60,11 +62,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
|
|
|
`expand`::
|
|
|
(Optional, Boolean) If true, the output includes anomaly records. Defaults to `false`.
|
|
|
|
|
|
-`page`.`from`::
|
|
|
+`from`::
|
|
|
(Optional, integer) Skips the specified number of buckets. Defaults to `0`.
|
|
|
|
|
|
-`page`.`size`::
|
|
|
-(Optional, integer) Specifies the maximum number of buckets to obtain. Defaults to `100`.
|
|
|
+`size`::
|
|
|
+(Optional, integer) Specifies the maximum number of buckets to obtain. Defaults
|
|
|
+to `100`.
|
|
|
|
|
|
`sort`::
|
|
|
(Optional, string) Specifies the sort field for the requested buckets. By
|
|
@@ -75,6 +78,26 @@ default, the buckets are sorted by the `timestamp` field.
|
|
|
`-1`, which means it is unset and results are not limited to specific
|
|
|
timestamps.
|
|
|
|
|
|
+[[ml-get-bucket-request-body]]
|
|
|
+== {api-request-body-title}
|
|
|
+
|
|
|
+You can also specify the query parameters in the request body; the exception are
|
|
|
+`from` and `size`, use `page` instead:
|
|
|
+
|
|
|
+`page`::
|
|
|
++
|
|
|
+.Properties of `page`
|
|
|
+[%collapsible%open]
|
|
|
+====
|
|
|
+
|
|
|
+`from`:::
|
|
|
+(Optional, integer) Skips the specified number of buckets. Defaults to `0`.
|
|
|
+
|
|
|
+`size`:::
|
|
|
+(Optional, integer) Specifies the maximum number of buckets to obtain. Defaults
|
|
|
+to `100`.
|
|
|
+====
|
|
|
+
|
|
|
[role="child_attributes"]
|
|
|
[[ml-get-bucket-results]]
|
|
|
== {api-response-body-title}
|
|
@@ -101,15 +124,16 @@ influencer. This score might be updated as newer data is analyzed.
|
|
|
(number) The length of the bucket in seconds. This value matches the
|
|
|
`bucket_span` that is specified in the job.
|
|
|
|
|
|
-`initial_anomaly_score`:::
|
|
|
-(number) The score between 0-100 for each bucket influencer. This score is the
|
|
|
-initial value that was calculated at the time the bucket was processed.
|
|
|
-
|
|
|
`influencer_field_name`:::
|
|
|
(string) The field name of the influencer.
|
|
|
-
|
|
|
+////
|
|
|
`influencer_field_value`:::
|
|
|
(string) The field value of the influencer.
|
|
|
+////
|
|
|
+
|
|
|
+`initial_anomaly_score`:::
|
|
|
+(number) The score between 0-100 for each bucket influencer. This score is the
|
|
|
+initial value that was calculated at the time the bucket was processed.
|
|
|
|
|
|
`is_interim`:::
|
|
|
(Boolean)
|