IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Predicts the future behavior of a time series by using its historical behavior.
If the Elasticsearch security features are enabled, you must have
managecluster privileges to use this API. See Security privileges.
You can delete a forecast by using the Delete forecast API.
If you use an
over_field_nameproperty in your job, you cannot create a forecast. For more information about this property, see Create jobs.
- The job must be open when you create a forecast. Otherwise, an error occurs.
(Optional, time units) A period of time that indicates how far
into the future to forecast. For example,
30dcorresponds to 30 days. The default value is 1 day. The forecast starts at the last record that was processed.
(Optional, time units) The period of time that forecast
results are retained. After a forecast expires, the results are deleted. The
default value is 14 days. If set to a value of
0, the forecast is never automatically deleted.