Sign in

v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB
Yield Forecast

Trigger a forecast of all available inventory

Triggers a forecast request of all available inventory, using the inventory priorities defined in the forecast settings. Results are grouped by three different date aggregation levels: daily, weekly, and monthly.

post/forecaster/trigger-inventory-forecast

Request body

samplinginteger

The level of sampling to set in the forecast request(s) being triggered. Defaults to the default sampling defined for the network.

startDatestring date

The start date of the forecast request(s) being triggered. Defaults to the current date.

endDatestring date

The end date of the forecast request(s) being triggered. Defaults to the date given by default date range defined for the network.

Response

Normal response, containing a JSON object with the result of the forecast trigger.

OR
OR

Example response

{
  "noResultReason": "Package does not contain valid targeting sets to derive forecast requests."
}