Predict future behavior of a time series

POST /_ml/anomaly_detectors/{job_id}/_forecast

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

Path Parameters

job_id string Id required: Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs.

Query Parameters

Request

Response

application/json

Examples

An example body for a POST _ml/anomaly_detectors/low_request_rate/_forecast request.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/anomaly_detectors/low_request_rate/_forecast
{
  "duration": "10d"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.forecast({
  job_id: "low_request_rate",
  duration: "10d",
});

Python Elasticsearch Python Client

resp = client.ml.forecast(
    job_id="low_request_rate",
    duration="10d",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/low_request_rate/_forecast" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "duration": "10d"
  }'

Java Elasticsearch Java Client

client.ml().forecast(f -> f
    .duration(d -> d
        .time("10d")
    )
    .jobId("low_request_rate")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .ForecastAsync(jobId: "low_request_rate", d1 => d1
        .Duration("10d")
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->forecast([
    "job_id" => "low_request_rate",
    "body" => [
        "duration" => "10d",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.forecast(
  job_id: "low_request_rate",
  body: {
    "duration": "10d"
  }
)

Response

No example

Required authorization

Path Parameters

Query Parameters { duration , expires_in , max_model_memory , }

Request { duration , expires_in , max_model_memory , }

Response

Query Parameters

Request