Predict future behavior of a time series Added in 6.1.0
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.
Path parameters
-
Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs.
Query parameters
-
duration string
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. -
expires_in string
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.
-
max_model_memory string
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.
Body
-
duration string
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
expires_in string
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
max_model_memory string
Refer to the description for the
max_model_memory
query parameter.
curl \
-X POST http://api.example.com/_ml/anomaly_detectors/{job_id}/_forecast \
-H "Content-Type: application/json" \
-d '{"duration":"string","expires_in":"string","max_model_memory":"string"}'
{
"duration": "string",
"expires_in": "string",
"max_model_memory": "string"
}
{
"acknowledged": true,
"forecast_id": "string"
}