Get Schedule Statistics
GET/api/inventory-forecasting/schedules/statistics
Get aggregate statistics for all forecast schedules.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
success_rate is the percentage of scheduled runs that completed successfully this week, over runs_scored_this_week (completed + failed runs). It is null when no run has been scored yet — an empty set has no success rate, so render an explicit "no runs yet" state rather than treating null as 0% or 100%.
Monetary totals are in the account's base currency.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.