Get anomaly detection job results for buckets

POST also GET /_ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}
POST also GET /_ml/anomaly_detectors/{job_id}/results/buckets

Api key auth Basic auth Bearer auth

The API presents a chronological view of the records, grouped by bucket.

Required authorization

Cluster privileges: monitor_ml

Path Parameters

Query Parameters

Request

Response

application/json

Examples

An example body for a GET _ml/anomaly_detectors/low_request_rate/results/buckets request.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/anomaly_detectors/low_request_rate/results/buckets
{
  "anomaly_score": 80,
  "start": "1454530200001"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.getBuckets({
  job_id: "low_request_rate",
  anomaly_score: 80,
  start: 1454530200001,
});

Python Elasticsearch Python Client

resp = client.ml.get_buckets(
    job_id="low_request_rate",
    anomaly_score=80,
    start="1454530200001",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/low_request_rate/results/buckets" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "anomaly_score": 80,
    "start": "1454530200001"
  }'

Java Elasticsearch Java Client

client.ml().getBuckets(g -> g
    .anomalyScore(80.0D)
    .jobId("low_request_rate")
    .start(DateTime.of("1454530200001"))
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .GetBucketsAsync(new GetBucketsRequest()
    {
        JobId = "low_request_rate",
        AnomalyScore = 80d,
        Start = DateTimeOffset.Parse("2016-02-03T20:10:00.0010000+00:00", CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind)
    });

PHP Elasticsearch PHP Client

$resp = $client->ml()->getBuckets([
    "job_id" => "low_request_rate",
    "body" => [
        "anomaly_score" => 80,
        "start" => "1454530200001",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.get_buckets(
  job_id: "low_request_rate",
  body: {
    "anomaly_score": 80,
    "start": "1454530200001"
  }
)

Response

No example

Required authorization

Path Parameters { job_id , timestamp , }

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

Request { anomaly_score , desc , end , exclude_interim , expand , page , sort , start , }

Response

Path Parameters

Query Parameters

Request