Skip to navigation
API ReferenceOkr

Get Key Result

With what the caller may do: canEdit (its definition) and canUpdate (its progress). A key may do both.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

keyResultIdstringRequired

Response

This endpoint returns an object.
canEditboolean

Whether the caller may change its definition: they may edit its objective. Always true for a key.

canUpdateboolean

Whether the caller may record its progress (check-ins, scorecard grades and comments): they may edit its objective, or it is theirs or one of their teams’. Always true for a key.

createdAtdatetime
draftboolean

Still being worked out, not yet agreed. A label only: a draft is seen, scored, rolled up and checked in on like any other.

idstring
objectiveIdstring
ownerTeamIdslist of strings

Teams of the workspace that own it; their members count as owners.

ownerUserIdslist of strings
Members of the workspace who own it, directly.
priorityenum

A key result’s priority, and the dimension scores are averaged by, so a workspace can see how it did on what mattered most rather than only in aggregate. Objectives have none: a priority’s average takes each objective on its key results of that priority alone, with the objective’s own weight.

Allowed values:
sortOrderinteger
Its place among its objective's key results, lowest first.
titlestring
updatedAtdatetime
weightdouble
Relative weight within its own objective, 0.01 to 100.
lastCheckInAtdatetimeOptional

When it was last checked in on: its newest check-in’s recordedAt, so a check-in recorded late counts at its date. Absent if it has never been checked in on. How long it has gone quiet.

metricobjectOptional

The connected metric that drives its score, absent if none. Each number the metric hears becomes a check-in, and a person’s own check-in stands only until the metric next moves. Sources are set up on the key result’s page in the app, not through the API.

scoredoubleOptional

Google-style grade from 0.0 to 1.0, or absent until it has been scored. 0.7 and up is delivered for an ambitious goal, 0.4 to 0.7 is progress, and under 0.4 is missed.

A Final grade set on the scorecard is the score. Until there is one, the score is the newest of the key result’s other scorecard grades and its latest check-in. A score reset on the scorecard (noScore) empties that cell only and leaves this alone. It is what the dashboard’s lists show, and what the objective’s score rolls up.

Errors

404
Not Found Error
429
Too Many Requests Error