Key Results

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:

{
"id": "16682617-f25d-4df2-9f51-3c38298996b8",
"name": "$40K in revenue from subscription sales",
"created_at": "2018-02-20T12:32:56Z",
"modified_at": "2018-02-20T12:32:56Z",
"objective_id": "12345678-f25d-4df2-9f51-3c38298996b8",
"type": "positive",
"confidence": "0.50",
"current_value": "10000.00",
"target_value_min": "40000.00",
"target_value_max": null
}

get
List Key Results

https://api.simpleokr.com/v1/keyresults
Returns a list of your Key Results.
Request
Response
Request
Query Parameters
page_token
optional
string
Page identifier
cycle_id
required
string
Cycle ID
Response
200: OK
{
"next_page_token": null,
"keyresults": [
{
"id": "16682617-f25d-4df2-9f51-3c38298996b8",
"name": "$40K in revenue from subscription sales",
"created_at": "2018-02-20T12:32:56Z",
"modified_at": "2018-02-20T12:32:56Z",
"objective_id": "12345678-f25d-4df2-9f51-3c38298996b8",
"type": "positive",
"confidence": "0.50",
"current_value": "10000.00",
"target_value_min": "40000.00",
"target_value_max": null
},
{...},
{...}
]
}

get
Retrieve Key Result

https://api.simpleokr.com/v1/keyresults/:id
Retrieve an existing Key Result.
Request
Response
Request
Path Parameters
id
required
string
Key Result ID
Response
200: OK
{
"id": "16682617-f25d-4df2-9f51-3c38298996b8",
"name": "$40K in revenue from subscription sales",
"created_at": "2018-02-20T12:32:56Z",
"modified_at": "2018-02-20T12:32:56Z",
"objective_id": "12345678-f25d-4df2-9f51-3c38298996b8",
"type": "positive",
"confidence": "0.50",
"current_value": "10000.00",
"target_value_min": "40000.00",
"target_value_max": null
}

post
Update Key Result

https://api.simpleokr.com/v1/keyresults/:id
Request
Response
Request
Path Parameters
id
required
string
Key Result ID
Body Parameters
target_value_max
optional
string
Maximum target value where applicable.
target_value_min
optional
string
Minimum target value where applicable.
objective_id
required
string
Objective ID.
current_value
optional
string
A decimal string representing current value.
confidence
optional
string
Confidence. A decimal string value between 0 and 1.
type
optional
string
Key Result type.
name
required
string
Key Result name.
Response
200: OK
{
"id": "16682617-f25d-4df2-9f51-3c38298996b8",
"name": "$40K in revenue from subscription sales",
"created_at": "2018-02-20T12:32:56Z",
"modified_at": "2018-02-20T12:32:56Z",
"objective_id": "12345678-f25d-4df2-9f51-3c38298996b8",
"type": "positive",
"confidence": "0.50",
"current_value": "10000.00",
"target_value_min": "40000.00",
"target_value_max": null
}

delete
Delete Key Result

https://api.simpleokr.com/v1/keyresults/:id
Deletes and existing Key Result.
Request
Response
Request
Path Parameters
id
required
string
Key Result ID
Response
200: OK