Skip to main content
POST
Create key result

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Body

application/json

Create payload for a key result.

name
string
required
Maximum string length: 200
Pattern: \S
metricSpec
object
required
aggregationType
enum<string>
required
Available options:
AVERAGE,
SUM,
GEOMETRIC_MEAN,
LAST_VALUE
criteriaType
enum<string>
required
Available options:
BASELINE,
INCREASE,
DECREASE,
MAINTAIN,
MILESTONE,
PERCENTAGE
initialValue
number
required
targetValue
number
required
endingPeriod
object
required
scoringType
enum<string>
required
Available options:
NO_ZONES,
TWO_ZONES_YES_NO,
TWO_ZONES_YES_NO_ASPIRATIONAL,
TWO_ZONES,
TWO_ZONES_ASPIRATIONAL,
TWO_ZONES_BEST_WORST,
THREE_ZONES,
THREE_ZONES_BEST_WORST,
FOUR_ZONES_ASPIRATIONAL,
FOUR_ZONES_SOFT_ORANGE,
FOUR_ZONES_SOFT_GREEN,
THREE_ZONES_MAINTAIN,
FIVE_ZONES_MAINTAIN
scoringThresholds
number[]
required
caretakers
object[]
required
Required array length: 1 - 2 elements
goal
object
required
context
string
Maximum string length: 500
steps
object[]
percentageItems
integer<int32>
autoResolveConflicts
boolean
template
object

Response

Key result created

id
string
status
enum<string>
Available options:
DRAFT,
PUBLISHED,
ACTIVE,
ABANDONED,
COMPLETED
modificationStatus
enum<string>
Available options:
NOT_MODIFIED,
PENDING,
MODIFIED
currentPeriod
object
confidence
enum<string>
Available options:
LOW,
MEDIUM,
HIGH
confidenceSource
enum<string>
Available options:
IMPLICIT,
CHECK_IN
checkInStats
object
clonedFrom
object
goal
object
name
string
context
string
steps
object[]
percentageItems
integer<int32>
latestNote
object