v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB

Demand Data

Get Demand Data

Returns the demand data that has been uploaded to the model. Supports filtering by date range.

By setting the Accept header, you can specify the format of the response. The default is JSON. Supported formats: application/json, text/csv, application/x-ndjson.

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

Path parameters

model_idstring required

The unique identifier of the forecast model.

Query parameters

date.gtstring date

Filters demand after the specified date (exclusive).

Expected format: YYYY-MM-DD

date.gtestring date

Filters demand on or after the specified date.

Expected format: YYYY-MM-DD.

Example: 2025-01-01

date.ltstring date

Filters demand before the specified date (exclusive).

Expected format: YYYY-MM-DD.

date.ltestring date

Filters demand on or before the specified date.

Expected format: YYYY-MM-DD.

Example: 2025-01-07

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.