Goals (OKR)

Goals (OKR)

The system supports goals and key results for employees, teams, departments, and the whole company.

• Goal — a high-level objective that can be nested through parent_goal_id.
• Key Result — a measurable indicator used to track progress toward a goal.
• Check-in — a recorded update to a key result value.

Hierarchy and weights

• Goals can form a nested hierarchy.
• Each goal and key result has a weight that affects the parent progress calculation.

Fetching data

When you request a goal with GET /api/v1/goals/{id}, the API returns the full structure, including nested key results and current progress.

Use POST /api/v1/goals/search to search goals.

Main filters include:

• owner_type — company, department, team, employee
• text — goal title text
• status — active, completed, cancelled
• is_shared — whether the goal is shared with other users
• confidence_level — on_track, at_risk, off_track
• date_period_start and date_period_end
• only_top_level — only goals without a parent
• parent_goal_id — list of parent goal IDs

Progress management

1. Create a goal: POST /api/v1/goals
2. Add a key result: POST /api/v1/goals/{goal_id}/key-results
3. Add a check-in: POST /api/v1/goals/{goal_id}/key-results/{kr_id}/checkin

Changing value and confidence_level recalculates the progress for the key result and all related parent goals.

Main Goal fields

• id
• title
• description
• owner_type
• owner_employee_id, owner_department_id, owner_team_id
• is_shared
• date_start, date_end
• status
• progress
• confidence_level
• weight
• is_archived
• goal_key_results_count
• has_children

Parent goal fields

parent_goal contains summary information about the parent goal, including:

• id
• parent_goal_id
• assign_to_ids
• visible_to_ids

The rest of the fields mirror the main goal structure.

Key results

goal_key_results is a collection of measurable result objects with fields such as:

• id
• goal_id
• title
• description
• metric_type
• start_value
• target_value
• current_value
• progress
• confidence_level
• weight

Check-ins

goal_key_result_check_ins stores the history of updates:

• id
• employee_id
• value

Service fields

• acl
• created_by
• assign_to
• visible_to