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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Request body

Response

application/json

count number required
influencers object[] required: Array of influencer objects

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/anomaly_detectors/high_sum_total_sales/results/influencers?desc=true&sort="influencer_score"

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/high_sum_total_sales/results/influencers?desc=true&sort=" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  influencer_score""

Java Elasticsearch Java Client

client.ml().getInfluencers(g -> g
    .desc(true)
    .jobId("high_sum_total_sales")
    .sort(""influencer_score"")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .GetInfluencersAsync(jobId: "high_sum_total_sales", d1 => d1
        .Desc(true)
        .Sort("\"influencer_score\"")
    );

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

No example

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body