WARNING: Version 6.0 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
The get influencers API enables you to retrieve job results for one or more influencers.
-
desc - (boolean) If true, the results are sorted in descending order.
-
end - (string) Returns influencers with timestamps earlier than this time.
-
exclude_interim - (boolean) If true, the output excludes interim results. By default, interim results are included.
-
influencer_score - (double) Returns influencers with anomaly scores higher than this value.
-
page -
-
from - (integer) Skips the specified number of influencers.
-
size - (integer) Specifies the maximum number of influencers to obtain.
-
-
sort -
(string) Specifies the sort field for the requested influencers.
By default the influencers are sorted by the
influencer_scorevalue. -
start - (string) Returns influencers with timestamps after this time.
The API returns the following information:
-
influencers - (array) An array of influencer objects. For more information, see Influencers.
You must have monitor_ml, monitor, manage_ml, or manage cluster
privileges to use this API. You also need read index privilege on the index
that stores the results. The machine_learning_admin and machine_learning_user
roles provide these privileges. For more information, see
Security Privileges and
Built-in Roles.
The following example gets influencer information for the it_ops_new_kpi job:
GET _xpack/ml/anomaly_detectors/it_ops_new_kpi/results/influencers
{
"sort": "influencer_score",
"desc": true
}
In this example, the API returns the following information, sorted based on the influencer score in descending order:
{
"count": 28,
"influencers": [
{
"job_id": "it_ops_new_kpi",
"result_type": "influencer",
"influencer_field_name": "kpi_indicator",
"influencer_field_value": "online_purchases",
"kpi_indicator": "online_purchases",
"influencer_score": 94.1386,
"initial_influencer_score": 94.1386,
"probability": 0.000111612,
"bucket_span": 600,
"is_interim": false,
"timestamp": 1454943600000
},
...
]
}