Create Check In
Record a grade. The check-in is history and is never updated. The key
result’s own score follows the newest of its latest check-in and its
scorecard grades, and a Final grade, once set, is the score, so
every read that only cares about now stays cheap. A check-in
recorded late, with a recordedAt before the latest one, goes into
the history where it belongs and leaves the current score alone. A
corrected grade is another check-in, because the point of the history
is what was believed when.
A key may write any key result’s. A signed-in session writes only
where its person may in the app: on a key result that is theirs or
one of their teams’, or on any of an objective they may edit (see
updateObjective). Anybody else gets 403 forbidden.
With checkpoint, it is also the key result’s grade at that
scorecard checkpoint, as the dashboard’s check-in form makes it.
On a key result a connected metric drives (metric on the key
result), a check-in stands only until the metric next moves: the
metric’s next check-in is then the latest. A Final grade on the
scorecard is the score whatever the metric does.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Request
When it stood there, for a check-in written up after the fact. Now when left out. It may be in the past, never in the future (a few minutes’ clock drift aside).
Also make this score the key result’s grade at that scorecard
checkpoint, as the dashboard’s check-in form does: MID or
FINAL for a quarterly objective, Q1, Q2, Q3 or FINAL for
an annual one (a 422 otherwise). It is recorded in the grade
changes like a grade set on the scorecard, and a FINAL grade
becomes the key result’s score. Whoever may check in may grade.
Response
Set when the key result’s connected metric recorded this check-in
rather than a person: the score was mapped from value between
the metric’s baseline and target. recordedBy is then whoever set
the metric up.