Get anomaly detection job results for influencers

POST also GET /_ml/anomaly_detectors/{job_id}/results/influencers

Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an influencer_field_name is specified in the job configuration.

Required authorization

Cluster privileges: monitor_ml

Path Parameters

job_id string Id required: Identifier for the anomaly detection job.

Query Parameters

Request

page {} Page: Configures pagination. This parameter has the from and size properties.

Response

application/json

Examples

An example body for a GET _ml/anomaly_detectors/high_sum_total_sales/results/influencers request.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/anomaly_detectors/high_sum_total_sales/results/influencers
{
  "sort": "influencer_score",
  "desc": true
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.getInfluencers({
  job_id: "high_sum_total_sales",
  sort: "influencer_score",
  desc: true,
});

Python Elasticsearch Python Client

resp = client.ml.get_influencers(
    job_id="high_sum_total_sales",
    sort="influencer_score",
    desc=True,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/high_sum_total_sales/results/influencers" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sort": "influencer_score",
    "desc": true
  }'

Java Elasticsearch Java Client

client.ml().getInfluencers(g -> g
    .jobId("high_sum_total_sales")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.GetInfluencersAsync(jobId: "high_sum_total_sales");

PHP Elasticsearch PHP Client

$resp = $client->ml()->getInfluencers([
    "job_id" => "high_sum_total_sales",
    "body" => [
        "sort" => "influencer_score",
        "desc" => true,
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.get_influencers(
  job_id: "high_sum_total_sales",
  body: {
    "sort": "influencer_score",
    "desc": true
  }
)

Response

No example

Required authorization

Path Parameters

Query Parameters { desc , end , exclude_interim , influencer_score , from , size , sort , start , }

Request

Response

Query Parameters