KeyResult

Create a Key Result

Creates a new Key Result for the specified Goal.

Required fields: title

Defaults:

  • type: percental
  • confidence_level: 10, unless the account sets another default
  • start_value: 0
  • target_value: 100 (for percental), 0 (for others)
  • current_value: equals start_value

Type-specific requirements:

  • monetary: Requires currency field (one of EUR, USD, GBP, JPY, RUB, CHF, NOK, CNY)
  • milestone: Requires milestones array with at least one milestone

Owner inheritance: If owners is not provided, the Key Result is owned by the parent Goal's owning user.

Read-only properties rejected: The following will result in a 422 error if provided: id, progress, workpath_url, supports, supported_by

post/goals/{id}/key_results

Request

  • Base URL: https://connect.workpath.com/api/v3
  • URL: https://connect.workpath.com/api/v3/goals/{id}/key_results
  • Auth: HTTP bearer

Request body

titlestring required

Title of the Key Result.

descriptionstring nullable

Detailed description of the Key Result.

type'numeric' | 'percental' | 'monetary' | 'milestone'

Type of Key Result. Determines how progress is measured.

  • percental: Progress measured as percentage (0-100)
  • numeric: Progress measured as a number
  • monetary: Progress measured in currency
  • milestone: Progress measured by completing milestones
confidence_levelinteger

Confidence level (1-10) indicating likelihood of achieving the target. Defaults to the organization's default confidence level.

  • 1-3: Off track
  • 4-6: At risk
  • 7-10: On track
current_valuenumber

Current progress value. Defaults to start_value if not provided.

start_valuenumber

Starting value for progress calculation.

target_valuenumber

Target value to achieve. Defaults to 100 for percental, 0 for others.

currency'EUR' | 'USD' | 'GBP' | 'JPY' | 'RUB' | 'CHF' | 'NOK' | 'CNY'

ISO 4217 currency code. Required when type is "monetary".

Example request

{
  "title": "Increase conversion rate to 5%",
  "description": "Track the conversion rate from trial to paid customers.",
  "type": "percental",
  "confidence_level": 10,
  "target_value": 100,
  "currency": "EUR",
  "milestones": [
    {
      "title": "Complete design phase"
    }
  ],
  "owners": {
    "users": [
      {
        "id": 1
      }
    ],
    "teams": [
      {
        "id": 1
      }
    ]
  }
}

Response

Created

idinteger required

Unique identifier for the Key Result.

titlestring required

Title of the Key Result.

descriptionstring nullable required

Detailed description of the Key Result.

progressnumber required

Progress towards the Key Result, expressed as a decimal (e.g., 0.72 = 72%). Can exceed the 0-1 range when overachieving (>1) or in edge cases (<0).

confidence_levelinteger required

The owner's confidence of reaching the target in time, from 1 to 10: 1-3 off track, 4-6 at risk, 7-10 on track. Recorded with every status update.

type'numeric' | 'percental' | 'monetary' | 'milestone' | 'contributing_goal' required

How the Key Result is measured: numeric (a number, e.g. customers won), percental (a percentage), monetary (an amount in currency) or milestone (a list of milestones that are done or not). contributing_goal Key Results take their progress from a supporting Goal and cannot be created through the API.

current_valuenumber required

The latest recorded value.

start_valuenumber required

The baseline the Key Result started from.

target_valuenumber required

The value to reach by the end of the Goal.

currencystring

ISO 4217 currency code. Only present for Key Results of type monetary.

workpath_urlstring uri required

URL to view the Key Result in the Workpath platform.

Example response

{
  "id": 12,
  "title": "Teams have drafted their quarterly goals",
  "description": "Track how many teams have created and published their Q1 goals in Workpath.",
  "progress": 0.72,
  "confidence_level": 8,
  "type": "numeric",
  "current_value": 18,
  "start_value": 0,
  "target_value": 25,
  "workpath_url": "https://acme.workpath.com/goals/42?openKeyResultDetailsId=12",
  "owners": {
    "users": [
      {
        "id": 3,
        "name": "Maria Schmidt"
      }
    ]
  },
  "supported_by": {
    "initiatives": [
      {
        "id": 7,
        "title": "Roll out OKR training program to all teams"
      },
      {
        "id": 14,
        "title": "Host weekly OKR office hours for team leads"
      }
    ],
    "key_results": [
      {
        "id": 31,
        "title": "Sales teams have drafted their quarterly goals"
      },
      {
        "id": 32,
        "title": "Engineering teams have drafted their quarterly goals"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.