Get Goal Template Suggestion
GET/api/success-plan/templates/:template/suggestion
Returns SKU.io's measured baseline suggestion for one template and the goal options you picked. Get Goal Templates carries the figure for each template's default options; call this whenever an option that changes what is measured changes (an oversells goal counting backorders or both), so the figure you offer as the baseline is the one baseline.use_measured will save.
success_plan:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
measured_suggestion is null for customer-entered templates, in retrospective mode, and when SKU.io has no full month of trustworthy data for those options. Its metric_key is the series measured (e.g. backorders.v1).
Authentication: Requires Bearer token with the success_plan:read scope. The user must hold the success_plan.view permission.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Not Found
Response Headers
Unprocessable Entity
Response Headers
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.