OpenSearch/docs/reference/ml/apis/get-job-stats.asciidoc

[role="xpack"]
[testenv="platinum"]
[[ml-get-job-stats]]
=== Get Job Statistics API
++++
<titleabbrev>Get Job Statistics</titleabbrev>
++++

Retrieves usage information for jobs.


==== Request



`GET _xpack/ml/anomaly_detectors/<job_id>/_stats`

`GET _xpack/ml/anomaly_detectors/<job_id>,<job_id>/_stats` +

`GET _xpack/ml/anomaly_detectors/_stats` +

`GET _xpack/ml/anomaly_detectors/_all/_stats` +


===== Description

You can get statistics for multiple jobs in a single API request by using a
group name, a comma-separated list of jobs, or a wildcard expression. You can
get statistics for all jobs by using `_all`, by specifying `*` as the
`<job_id>`, or by omitting the `<job_id>`.


==== Path Parameters

`job_id`::
  (string) An identifier for the job. It can be a job identifier, a group name,
  or a wildcard expression. If you do not specify one of these options, the API
  returns statistics for all jobs.


==== Results

The API returns the following information:

`jobs`::
  (array) An array of job statistics objects.
  For more information, see <<ml-jobstats,Job Statistics>>.


==== Authorization

You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
privileges to use this API. For more information, see
{xpack-ref}/security-privileges.html[Security Privileges].


==== Examples

The following example gets usage information for the `farequote` job:

[source,js]
--------------------------------------------------
GET _xpack/ml/anomaly_detectors/farequote/_stats
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

The API returns the following results:
[source,js]
----
{
  "count": 1,
  "jobs": [
    {
      "job_id": "farequote",
      "data_counts": {
        "job_id": "farequote",
        "processed_record_count": 86275,
        "processed_field_count": 172550,
        "input_bytes": 6744714,
        "input_field_count": 172550,
        "invalid_date_count": 0,
        "missing_field_count": 0,
        "out_of_order_timestamp_count": 0,
        "empty_bucket_count": 0,
        "sparse_bucket_count": 15,
        "bucket_count": 1528,
        "earliest_record_timestamp": 1454803200000,
        "latest_record_timestamp": 1455235196000,
        "last_data_time": 1491948163685,
        "latest_sparse_bucket_timestamp": 1455174900000,
        "input_record_count": 86275
      },
      "model_size_stats": {
        "job_id": "farequote",
        "result_type": "model_size_stats",
        "model_bytes": 387594,
        "total_by_field_count": 21,
        "total_over_field_count": 0,
        "total_partition_field_count": 20,
        "bucket_allocation_failures_count": 0,
        "memory_status": "ok",
        "log_time": 1491948163000,
        "timestamp": 1455234600000
      },
      "state": "closed"
    }
  ]
}
----