List Reading Records
GET/api/success-plan/readings/:reading/records
Shows the records behind a measured reading: the ones it counted, or the ones an exclusion rule left out. The records are re-run live and paged.
success_plan:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Only measured readings have records; entered readings answer 422. For a settled month whose re-run totals now differ, drift holds the stored and now totals (value, included, excluded per rule); otherwise it is null.
Authentication: Requires Bearer token with the success_plan:read scope. The user must hold the success_plan.view permission.
Response: the paginated records (data, current_page, per_page, total, …), plus bucket, rule, drift, method_doc (how the figure is measured), method_version, rules (each exclusion rule as key, label, count) and reading (the reading with its period, state, counts and breakdown). Record fields depend on the metric; oversell records carry the sales order, product, warehouse, date, quantity and claim status.
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.