Skip to content

Goal

A Goal is what a Thing is trying to achieve: an objective with one or more Key Results.

Every Startup holds one Goal it must reach: its Minimum Success Criteria.

Properties

PropertyTypeRequiredDescription
objectivetextrequiredThe qualitative outcome.
horizonstringOne of day, week, quarter, year, or three-years.

Object

JSON
{
  "$id": "https://api.sb/shiftnote.app/goals/goal_1",
  "$type": "Goal",
  "objective": "Example objective",
  "horizon": "day"
}

Relationships

Verbs

  1. createCreates a Goal.
    POST /{namespace}/goalsdoGoal.created
  2. getReturns one Goal by id.
    GET /{namespace}/goals/{id}readNo Event
  3. listReturns Goals, newest first, one page at a time.
    GET /{namespace}/goalsreadNo Event
  4. updateChanges the given properties of a Goal.
    PATCH /{namespace}/goals/{id}doGoal.updated
  5. deleteDeletes a Goal; its history is kept.
    DELETE /{namespace}/goals/{id}doGoal.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Goal.createYesYesYesNo
Goal.getYesYesYesYes
Goal.listYesYesYesYes
Goal.updateYesYesYesNo
Goal.deleteYesYesYesNo

Call it

Text
Add a goal to RouteWise.

Example

A clinic-reminder SaaS holds a Goal with the objective "cut no-shows for 200 clinics" and horizon: year. Its one Key Result moves paid clinics from 35 to 200.