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
}

List Key Results

GET https://api.simpleokr.com/v1/keyresults

Returns a list of your Key Results.

Query Parameters

Name	Type	Description
page_token	string	Page identifier
cycle_id	string	Cycle ID

200

{
  "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
    },
    {...},
    {...}
  ]
}

Retrieve Key Result

GET https://api.simpleokr.com/v1/keyresults/:id

Retrieve an existing Key Result.

Path Parameters

Name	Type	Description
id	string	Key Result ID

200

{
  "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
}

Update Key Result

POST https://api.simpleokr.com/v1/keyresults/:id

Path Parameters

Name	Type	Description
id	string	Key Result ID

Request Body

Name	Type	Description
target_value_max	string	Maximum target value where applicable.
target_value_min	string	Minimum target value where applicable.
objective_id	string	Objective ID.
current_value	string	A decimal string representing current value.
confidence	string	Confidence. A decimal string value between 0 and 1.
type	string	Key Result type.
name	string	Key Result name.

200

{
  "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 Key Result

DELETE https://api.simpleokr.com/v1/keyresults/:id

Deletes and existing Key Result.

Path Parameters

Name	Type	Description
id	string	Key Result ID

200