Skip to main content

List Forecast Accuracy

GET 

/api/inventory-forecasting/accuracy

List a product's forecast-accuracy history across runs, paginated. Each entry compares a run's projected demand against the actual quantity sold in the evaluation window.

Required scope: purchase-orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Query parameters:

  • product_id (required): the product to read accuracy for.
  • page (default 1), per_page (default 15).

Each entry reports ape (absolute percentage error), signed_bias with a bias_direction of over, under, or none, a tracking_signal, and is_drifting when the forecast is trending off.

forecast_quantity is the demand the run projected for the evaluation window: the stored line's inputs.daily_average multiplied by the window's days (not the line's order quantity). Saved scheduled runs are scored automatically by the nightly sku:forecasting:evaluate-accuracy sweep once 30 days have elapsed, over the 30 days after the run.

run_link is the app path of the scored forecast run, or null once that run has been purged (runs that created no purchase orders are deleted 37 days after they run; their accuracy scores are kept).

Request​

Responses​

OK

Response Headers
    Content-Type