ProductPlan · Schema

KeyResult

A key result (KR) belonging to an OKR objective in ProductPlan.

Road MappingProduct ManagementOKRRoadmapsFeaturesProduct StrategyLaunchesDiscoveryIntegrations

Properties

Name Type Description
id integer Unique identifier for the key result
title string Title of the key result
description string Detailed description
progress number Progress percentage toward achieving this key result
objective_id integer ID of the parent objective
created_at string
updated_at string
View JSON Schema on GitHub

JSON Schema

key-result.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/productplan/main/json-schema/key-result.json",
  "title": "KeyResult",
  "description": "A key result (KR) belonging to an OKR objective in ProductPlan.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique identifier for the key result"
    },
    "title": {
      "type": "string",
      "description": "Title of the key result"
    },
    "description": {
      "type": "string",
      "description": "Detailed description"
    },
    "progress": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Progress percentage toward achieving this key result"
    },
    "objective_id": {
      "type": "integer",
      "description": "ID of the parent objective"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": ["id", "title", "objective_id"]
}