Key Results

Search…

Welcome

FAQ

Simple OKR Manual

Objectives & Key Results

Configuration & Settings

Developer API

Key Results are quantitative metrics that let you track Objective's performance.

The Key Result Object
Attribute
Type
Description
id
string
Unique key result identifier.
name
string
Name of the key result.
created_at
string
Time when the key result was created. RFC 3339 format.
modified_at
string
Time when the key result was last updated. RFC 3339 format.
objective_id
string
Objective identifier.
confidence
string
Decimal string between 0.0 and 1.0 indicating confidence of reaching the target.
type
string
Metric type. One of milestone, baseline, range, positive, negative.
current_value
string
Decimal. Current metric value.
target_value_min
string, nullable
Decimal. Minimum target value.
target_value_max
string, nullable
Decimal. Maximum target value.
Target values are optional for some metric types.
postive and negative metrics will have only target_value_min set.
range metrics will have both target_value_min and target_value_max set.
baseline will not have either of the target values set.
milestone will always have target_value_min set to 1.00.
Example:
1
{
2
  "id": "16682617-f25d-4df2-9f51-3c38298996b8",
3
  "name": "$40K in revenue from subscription sales",
4
  "created_at": "2018-02-20T12:32:56Z",
5
  "modified_at": "2018-02-20T12:32:56Z",
6
  "objective_id": "12345678-f25d-4df2-9f51-3c38298996b8",
7
  "type": "positive",
8
  "confidence": "0.50",
9
  "current_value": "10000.00",
10
  "target_value_min": "40000.00",
11
  "target_value_max": null
12
}
Copied!
get
https://api.simpleokr.com
/v1/keyresults
List Key Results
get
https://api.simpleokr.com
/v1/keyresults/:id
Retrieve Key Result
post
https://api.simpleokr.com
/v1/keyresults/:id
Update Key Result
delete
https://api.simpleokr.com
/v1/keyresults/:id
Delete Key Result

Objectives

Last modified 2yr ago

Copy link

Contents

The Key Result Object