Success Plans

📄️Get Success Plan

Returns the whole success plan in one payload: the plan (`mode` is `kickoff` when the plan started near go-live, `retrospective` when it started more than 30 days after), the active goals with their baselines, latest readings, change, target and trend, this week's `focus` (the first off-track goal and its next step, or null), the check-in schedule, current sharing consent, the latest 20 story entries, drafts awaiting your review, and whether the profile is complete.

📄️Get Goal Templates

Lists the goal templates in display order. Each template has its `key`, `name`, `metric_key` (what SKU.io measures, or null), allowed `units` (the first is the default), `direction`, `measurement` (`measured`, `customer` or `hybrid`), the `check_in_question` asked later, `help`, `options` (option key to allowed values), `directions` (only `custom` offers a choice) and `by_role` (hours are entered per role).

📄️Get Goal 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.

📄️Get Profile Taxonomy

Returns the fixed vocabularies the profile uses, each as a list of `{key, label}`: industries, the jobs a previous tool covered, previous tools, alternatives considered, and the orders-per-month and SKU-count bands. Keys are stable; labels may change. Any list also accepts `other:<your text>`.

📄️Create Success Plan Goal

Creates a goal with its baseline. The title is the customer's own words; the template only pre-fills the unit, direction and measurement. A plan holds at most three active goals.

📄️Update Success Plan Goal

Edits a goal's title, target value or target date. Send only the fields to change. The unit can't change (archive the goal and add a new one), and the baseline is never overwritten here: use Correct Goal Baseline.

📄️Correct Goal Baseline

Records a corrected baseline. The old baseline is kept and marked superseded, and the correction is logged with its reason. In retrospective mode, a goal with no 'before' yet takes its first baseline here and no reason is needed.

📄️Archive Success Plan Goal

Archives a goal. Its readings are kept, it no longer counts toward the three active goals, and it can't be changed afterwards. No body.

📄️List 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.

📄️Add Goal Reading

Records a new value you entered on a goal (a C reading). Earlier readings are kept. When the value reaches the target, the goal becomes `met`.

📄️Mark Success Plan Goal Met

Marks a goal with no target as met ('We got there'). Goals with a target are marked met by SKU.io when a reading reaches it, so they answer 422 `goal_has_target`. The goal-met result is logged in the story, and the goal becomes eligible for the goal-met response (see Respond to Goal Met).

📄️List 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.

📄️Get Packaging Exclusions

Returns the packaging and consumables exclusion list: products SKU.io leaves out of measured figures such as stock-count adjustments, chosen by product category, tag or individual product.

📄️Update Packaging Exclusions

Replaces the packaging and consumables exclusion list. Provisional months are re-measured in the background (`remeasure_queued: true`); settled months keep their figures until you run Recompute Measured History.

📄️Recompute Measured History

Re-measures every month since go-live (at most 26) with the current exclusion list. A settled month whose figure changed is restated: the old reading is kept and the new one carries the reason. Runs before it responds, so it can take a little while.

📄️Upload Success Plan Attachment

Uploads a file as `multipart/form-data`. Up to 20 MB. Accepted types: jpg, jpeg, png, gif, webp, heic, pdf, csv, txt, xlsx; a `clip` also accepts mp4, mov, webm, m4a and mp3.

📄️Download Success Plan Attachment

Downloads an attachment. Use the signed `url` returned with the attachment (on upload, and in every reading's `attachments`): it already carries `expires` and `signature`, and is valid for 30 minutes. Fetch a fresh one by reading the goal or its readings again. The request must also be authenticated.

📄️Get Success Plan Profile

Returns the profile, every field labeled with where it came from.

📄️Update Success Plan Profile

Saves the profile fields you send; fields you leave out are unchanged. Sending an auto-filled field's own SKU.io value, or null, puts it back to the SKU.io value.

📄️Answer Check-in

Answers a due, snoozed, lapsed or skipped check-in. Each answer names one of the check-in's questions. Number, hours-by-role, yes/no and checklist answers become readings you entered on the goal; `text` answers are saved as quotes in your own words. Answer at least one question.