List Promo Windows
GET/api/inventory-forecasting/promo-windows
List all promo windows, including any realised lift (measured_lift_pct) and post-promo dip (post_promo_dip_pct) already measured for each. Use a window's id as the promo_window_id of a promo_lift demand modifier to re-apply its lift on a build.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
suggested_modifiers: the forward Event modifiers built from the window's persisted measurement (the same shape Measure Promo Lift returns), so a previously measured window can be applied without re-measuring. Empty until the window has been measured. The second modifier is named '<window> post-promo dip' when post_promo_dip_pct is negative and '<window> post-promo carryover' when demand stayed elevated after the promo (positive).
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.