NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« Get datafeed statistics API Get jobs API »

› › ›

Get influencers API

edit

Get influencers API

edit

Retrieves job results for one or more influencers.

Request

edit

GET _xpack/ml/anomaly_detectors/<job_id>/results/influencers

Path Parameters

edit

job_id: (string) Identifier for the job.

Request Body

edit

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 greater or equal 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_score value.

start

(string) Returns influencers with timestamps after this time.

Results

edit

The API returns the following information:

influencers: (array) An array of influencer objects. For more information, see Influencers.

Authorization

edit

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.

Examples

edit

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
    },
  ...
  ]
}

« Get datafeed statistics API Get jobs API »