Type to search.

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
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 5.4 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Required privileges

Cluster privileges monitor_ml

Path parameters

job_id string required

Identifier for the anomaly detection job.

category_id number optional

Identifier for the category, which is unique in the job. If you specify neither the category ID nor the partition_field_value, the API returns information about all categories. If you specify only the partition_field_value, it returns information about all categories for the specified partition.

Leave it out to use /_ml/anomaly_detectors/{job_id}/results/categories.

Query parameters

from number · default: 0

Skips the specified number of categories.

partition_field_value string

Only return categories for the specified partition.

size number · default: 100

Specifies the maximum number of categories to obtain.

Request body

Response

application/json
categories object[] required
category_id number required

A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled.

examples string[] required

A list of examples of actual values that matched the category.

grok_pattern string

[experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking.

job_id string required

Identifier for the anomaly detection job.

max_matching_length number required

The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed.

partition_field_name string

If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled.

partition_field_value string

If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled.

regex string required

A regular expression that is used to search for values that match the category.

terms string required

A space separated list of the common tokens that are matched in values of the category.

num_matches number

The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close

preferred_to_categories string[]

A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close

p string
result_type string required
mlcategory string required
count number required