Работа с целями (OKR)
Работа с целями (OKR)
Заголовок раздела «Работа с целями (OKR)»Система позволяет управлять целями и ключевыми результатами для сотрудников, команд и компании.
Goal— высокоуровневая цель. Цели могут быть вложенными и иметьparent_goal_id.Key Result— измеримый показатель достижения цели.Check-in— запись об изменении значения ключевого результата.
Иерархия и веса
Заголовок раздела «Иерархия и веса»- Цели могут иметь вложенную структуру.
- У каждой цели и каждого ключевого результата есть
weight, который влияет на прогресс родительской сущности.
Получение данных
Заголовок раздела «Получение данных»При запросе конкретной цели через GET /api/v1/goals/{id} возвращаются все данные, включая вложенные ключевые результаты и текущий прогресс.
Для поиска целей используйте POST /api/v1/goals/search.
Основные параметры фильтрации:
owner_type—company,department,team,employeetext— текст в названии целиstatus—active,completed,cancelledis_shared— доступна ли цель другим пользователямconfidence_level—on_track,at_risk,off_trackdate_period_startиdate_period_endonly_top_level— только цели без родителяparent_goal_id— список родительских целей
Управление прогрессом
Заголовок раздела «Управление прогрессом»- Создание цели:
POST /api/v1/goals - Добавление key result:
POST /api/v1/goals/{goal_id}/key-results - Check-in:
POST /api/v1/goals/{goal_id}/key-results/{kr_id}/checkin
Изменение value и confidence_level приводит к пересчёту прогресса ключевого результата и связанных вышестоящих целей.
Основные поля Goal
Заголовок раздела «Основные поля Goal»id— уникальный идентификатор целиtitle— название целиdescription— описаниеowner_type— тип владельца целиowner_employee_id,owner_department_id,owner_team_id— ID владельца в зависимости от типаis_shared— доступность для других пользователейdate_start,date_end— период действия целиstatus— текущий статусprogress— текущий прогресс в процентахconfidence_level— уровень уверенности в достиженииweight— вес цели относительно родителяis_archived— признак архивацииgoal_key_results_count— количество ключевых результатовhas_children— есть ли вложенные цели
Поля parent goal
Заголовок раздела «Поля parent goal»parent_goal содержит краткую информацию о родительской цели, включая:
idparent_goal_idassign_to_idsvisible_to_ids
Остальные поля повторяют основные поля цели.
Ключевые результаты
Заголовок раздела «Ключевые результаты»goal_key_results — массив объектов с измеримыми показателями.
idgoal_idtitledescriptionmetric_type—number,percentage,currency,booleanstart_valuetarget_valuecurrent_valueprogressconfidence_levelweight
Check-ins
Заголовок раздела «Check-ins»goal_key_result_check_ins хранит историю изменений:
idemployee_idvalue
Служебные поля
Заголовок раздела «Служебные поля»acl— права доступа текущего пользователяcreated_by— создатель целиassign_to— назначенный сотрудникvisible_to— список сотрудников с правом просмотра