Predict future behavior of a time series

POST /_ml/anomaly_detectors/{job_id}/_forecast

Copy endpoint

Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an over_field_name in its configuration. Forcasts predict future behavior based on historical data.

Required authorization

Cluster privileges: manage_ml

Parameters

path Path Parameters

Name	Type
`job_id` required Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs.	type TypesId = string

query Query Parameters

Name	Type
`duration` A period of time that indicates how far into the future to forecast. For example, `30d` corresponds to 30 days. The forecast starts at the last record that was processed.	type TypesDuration = string \| "-1" \| "0"
`expires_in` The period of time that forecast results are retained. After a forecast expires, the results are deleted. If set to a value of 0, the forecast is never automatically deleted.	type TypesDuration = string \| "-1" \| "0"
`max_model_memory` The maximum memory the forecast can use. If the forecast needs to use more than the provided amount, it will spool to disk. Default is 20mb, maximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s configured memory limit, it is automatically reduced to below that amount.	string

Request Body

application/json

{ duration?:

TypesDuration

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

type TypesDuration = string | "-1" | "0"

;expires_in?:

TypesDuration

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

type TypesDuration = string | "-1" | "0"

;max_model_memory?: string; }

Responses

200 application/json

{ acknowledged: boolean;forecast_id:

TypesId

type TypesId = string

; }