Sign in

v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB
Forecasts

Get Forecast

Returns the generated forecast results for a trained model. Each result includes a date and predicted demand value. Supports filtering by date range.

get/v1/forecasts/models/{model_id}/forecast

Path parameters

model_idstring required

The unique identifier of the forecast model.

Query parameters

date.gtstring date

Filters forecast results after the specified date (exclusive).

Expected format: YYYY-MM-DD

date.gtestring date

Filters forecast results on or after the specified date.

Expected format: YYYY-MM-DD.

Example: 2025-01-01

date.ltstring date

Filters forecast results before the specified date (exclusive).

Expected format: YYYY-MM-DD.

date.ltestring date

Filters forecast results on or before the specified date.

Expected format: YYYY-MM-DD.

Example: 2025-01-07

includestring[]

A comma-separated list of additional fields to include in each forecast result. By default these fields are omitted:

  • phq_features: The demand intelligence features used in training and forecasting.
  • phq_explainability: The top events impacting demand on each forecasted date.
limitinteger

Maximum number of results to return per page.

offsetinteger

Zero-based index of the first result to return.

Response

Successful Response

errorsstring[]

List of error messages, if any.

warningsstring[]

List of warning messages, if any.

countinteger required

Total number of results matching the query.

nextstring nullable

URL for the next page of results. Null if no more results.

previousstring nullable

URL for the previous page of results. Null if on the first page.