IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Forecast jobs API

edit

Forecast jobs API

edit

Predicts the future behavior of a time series by using its historical behavior.

Request

edit

POST _xpack/ml/anomaly_detectors/<job_id>/_forecast

Description

edit

See Forecasting the future.

If you use an over_field_name property in your job, you cannot create a forecast. For more information about this property, see Job resources.
The job must be open when you create a forecast. Otherwise, an error occurs.

Path Parameters

edit

job_id: (string) Identifier for the job.

Request Parameters

edit

duration: (time units) A period of time that indicates how far into the future to forecast. For example, 30d corresponds to 30 days. The default value is 1 day. The forecast starts at the last record that was processed. For more information about time units, see Time units.
expires_in: (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. For more information about time units, see Time units.

Authorization

edit

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security privileges.

Examples

edit

The following example requests a 10 day forecast for the total-requests job:

POST _xpack/ml/anomaly_detectors/total-requests/_forecast
{
  "duration": "10d"
}

When the forecast is created, you receive the following results:

{
  "acknowledged": true,
  "forecast_id": "wkCWa2IB2lF8nSE_TzZo"
}

You can subsequently see the forecast in the Single Metric Viewer in Kibana.

« Flush jobs API Get calendars API »