KeyResult
/api/v1/okr/key-resultsA measurable result rolling up to an Objective.
listgetcreateupdatedeleteSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| objective_id | string | ID of the Objective this KeyResult contributes to. |
| title | string | Short, descriptive title for this KeyResult. |
| metric_type | string | The measurement type that governs how progress is computed. |
| baseline | number | Starting value of the metric at the time this KeyResult was created. |
| target | number | The value the metric must reach for this KeyResult to be considered achieved. |
| current | number | Latest observed value of the metric. |
| unit | string | Human-readable unit label for the metric (e.g. 'MRR', '%', 'count', 'milestone'). |
| direction | string | Whether progress is made by the metric going up (increase) or down (decrease). |
| owner_id | string | User ID of the person accountable for this KeyResult. Format: usr-<uuid>. |
| data_source | string | How the current metric value is sourced. |
| connector_id | string | ID of the connector used to pull metric data automatically. Null for manual or query sources. |
| query | string | Metric query expression used when dataSource is 'query'. |
| progress_pct | number | Computed progress percentage (0–100) based on baseline, current, and target. |
| status | string | Current health status of this KeyResult. |
| last_update_at | date-time | ISO 8601 timestamp when the current metric value was last updated. |
| history | json | Ordered log of metric value snapshots over time. |
| tags | json | Free-form string tags for filtering and grouping. |
| version | number | Optimistic-lock version counter, incremented on each write. |
API
client.okr.keyResults.*Loading manifest…