Skip to main content

List Goal Readings

GET 
/api/success-plan/goals/:goal/readings

Lists every reading on a goal, newest first: SKU.io's measured months (M), values you entered (C) and figures SKU.io staff recorded from a call or email (S). Corrected and restated readings stay in the list with superseded: true, and their replacements point back through supersedes_reading_id with a restatement_reason. Not paginated.

Required scope: success_plan:read

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

In retrospective mode SKU.io's own measured readings are left out until the goal's "before" is answered.

Authentication: Requires Bearer token with the success_plan:read scope. The user must hold the success_plan.view permission.

Response: data (labeled readings), goal_id, and hero (eligible, reasons): whether the goal's baseline and latest reading could carry a published headline (both settled measured months, or entered figures backed by a document or export).

Labeled values. Every number in a success-plan response is an object, never a bare figure: value (or value_bool for yes/no goals), unit, source (measured, customer_entered, staff_entered), label (M, C or S), source_description, evidence (system, document, system_export, estimate, recall), as_of, period (Y-m for a measured month), state (provisional, settled, partial; measured months only), hero_eligible, range_low / range_high and confidence (estimates and recalled values), and a note. Stored readings also carry reading_id, breakdown (e.g. hours by role), method_version, counts (records included and excluded per rule), entered_by, is_baseline, supersedes_reading_id / superseded / restatement_reason for corrections, check_in_id, display (how the figure may be quoted: estimates read "about N (customer estimate)") and attachments.

Request​

Responses​

OK

Response Headers
    Content-Type