|
@@ -33,6 +33,40 @@ the anomalies. Influencer results are available only if an
|
|
|
(Required, string)
|
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
|
|
|
|
|
+
|
|
|
+[[ml-get-influencer-query-parms]]
|
|
|
+== {api-query-parms-title}
|
|
|
+
|
|
|
+`desc`::
|
|
|
+(Optional, Boolean)
|
|
|
+include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results]
|
|
|
+
|
|
|
+`exclude_interim`::
|
|
|
+(Optional, Boolean)
|
|
|
+include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
|
|
|
+
|
|
|
+`from`::
|
|
|
+(Optional, integer)
|
|
|
+Skips the specified number of influencers. Defaults to `0`.
|
|
|
+
|
|
|
+`influencer_score`::
|
|
|
+(Optional, double) Returns influencers with anomaly scores greater than or
|
|
|
+equal to this value. Defaults to `0.0`.
|
|
|
+
|
|
|
+`size`::
|
|
|
+(Optional, integer)
|
|
|
+Specifies the maximum number of influencers to obtain. Defaults to `100`.
|
|
|
+
|
|
|
+`sort`::
|
|
|
+(Optional, string) Specifies the sort field for the requested influencers. By
|
|
|
+default, the influencers are sorted by the `influencer_score` value.
|
|
|
+
|
|
|
+`start`::
|
|
|
+(Optional, string) Returns influencers with timestamps after this time. Defaults
|
|
|
+to `-1`, which means it is unset and results are not limited to specific
|
|
|
+timestamps.
|
|
|
+
|
|
|
+
|
|
|
[[ml-get-influencer-request-body]]
|
|
|
== {api-request-body-title}
|
|
|
|