New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get machine learning info API Get overall buckets API »
Elastic Docs ›Elasticsearch Guide [7.4] ›REST APIs ›Machine learning anomaly detection APIs

Get model snapshots API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get model snapshots API

edit

Retrieves information about model snapshots.

Request

edit

GET _ml/anomaly_detectors/<job_id>/model_snapshots

GET _ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. See Security privileges.

Path parameters

edit
<job_id>
(Required, string) Identifier for the anomaly detection job.
<snapshot_id>
(Optional, string) Identifier for the model snapshot. If you do not specify this optional parameter, the API returns information about all model snapshots.

Request body

edit
desc
(Optional, boolean) If true, the results are sorted in descending order.
end
(Optional, date) Returns snapshots with timestamps earlier than this time.
from
(Optional, integer) Skips the specified number of snapshots.
size
(Optional, integer) Specifies the maximum number of snapshots to obtain.
sort
(Optional, string) Specifies the sort field for the requested snapshots. By default, the snapshots are sorted by their timestamp.
start
(Optional, string) Returns snapshots with timestamps after this time.

Response body

edit

The API returns the following information:

model_snapshots
(array) An array of model snapshot objects. For more information, see Model snapshot resources.

Examples

edit
GET _ml/anomaly_detectors/farequote/model_snapshots
{
  "start": "1491852977000"
}
Copy as curlTry in Elastic 

In this example, the API provides a single result:

{
  "count": 1,
  "model_snapshots": [
    {
      "job_id": "farequote",
      "min_version": "6.3.0",
      "timestamp": 1491948163000,
      "description": "State persisted due to job close at 2017-04-11T15:02:43-0700",
      "snapshot_id": "1491948163",
      "snapshot_doc_count": 1,
      "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
      },
      "latest_record_time_stamp": 1455235196000,
      "latest_result_time_stamp": 1455234900000,
      "retain": false
    }
  ]
}
« Get machine learning info API Get overall buckets API »
Was this helpful?
Feedback