Get anomaly detection job results for categories

POST also GET /_ml/anomaly_detectors/{job_id}/results/categories/{category_id}
POST also GET /_ml/anomaly_detectors/{job_id}/results/categories

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

categories object[] required
count number required

Examples

Request Console 1 / 8 languages

An example body for a GET _ml/anomaly_detectors/esxi_log/results/categories request.

Console Kibana Dev Tools

POST _ml/anomaly_detectors/esxi_log/results/categories
{
  "page":{
    "size": 1
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.getCategories({
  job_id: "esxi_log",
  page: {
    size: 1,
  },
});

Python Elasticsearch Python Client

resp = client.ml.get_categories(
    job_id="esxi_log",
    page={
        "size": 1
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/esxi_log/results/categories" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "page": {
      "size": 1
    }
  }'

Java Elasticsearch Java Client

client.ml().getCategories(g -> g
    .jobId("esxi_log")
    .page(p -> p
        .size(1)
    )
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .GetCategoriesAsync(new GetCategoriesRequest()
    {
        JobId = "esxi_log",
        Page = new()
        {
            Size = 1
        }
    });

PHP Elasticsearch PHP Client

$resp = $client->ml()->getCategories([
    "job_id" => "esxi_log",
    "body" => [
        "page" => [
            "size" => 1,
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.get_categories(
  job_id: "esxi_log",
  body: {
    "page": {
      "size": 1
    }
  }
)

Response

No example

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body