actionenum
Что делать. По умолчанию "list".
aggregationenum
Для ключевых результатов: как страны складываются в регион. sum (по умолчанию) для подсчётов и денег, average для ставок и уровней, none перечисляет страны без итога.
baselinenumber
Для ключевых результатов: с какого значения начинался показатель. Достижение идёт от базового значения к целевому.
briefstring
Короткое описание того, что это за проект.
budget_amountnumber
Budget. Требует budget_currency. Никогда не конвертируется между валютами.
budget_currencystring
Трёхбуквенный код валюты бюджета, например EUR.
commitmentenum
Для целей: committed (ожидается на уровне 1.0) или aspirational (0.7 - хороший результат). Изменяет правило статуса её ключевых результатов, но никогда не число.
contributorsstring[]
Все остальные, кто над этим работает. Ось person группирует по этим именам вместе с владельцем.
countrystring
Регион или страна, которая управляет им, в формулировке самого аккаунта ("DACH", "Nordics"), а не код ISO.
country_columnstring
Для ключевых результатов с dataset_id: столбец, который называет страну строки (autario_entity, когда он есть в наборе данных). Затем value_column считывается по каждой стране; страна, которой нет в наборе данных, сохраняет своё типизированное значение.
country_valuesobject[]
Для ключевых результатов: значение по каждой стране, [{ country, current, target }]; country задаётся названием или кодом ISO. Итог по региону использует эти значения; несколько стран без значений никогда не разбиваются.
dataset_idstring
Для ключевых результатов: датасет, из которого читается значение (любой датасет в этом аккаунте).
directionenum
Для ключевых результатов: что лучше - больше или меньше. По умолчанию: увеличение.
effort_daysnumber
Оценка трудозатрат в человеко-днях.
ends_onstring
Для целей: конец этого окна, YYYY-MM-DD.
filter_columnstring
Для ключевых результатов: необязательный столбец, по которому фильтруется набор данных.
filter_valuestring
Для ключевых результатов: значение filter_column должно иметь.
formatenum
Формат выходных данных для этого вызова MCP. По умолчанию: 'toon' (Token-Oriented Notation, меньше всего токенов, лучше всего подходит для табличных строк). 'compact' = минифицированный JSON. 'json' = форматированный JSON для удобства чтения. REST API всегда возвращает JSON независимо от выбранного формата.
functionstring
Функция, которая его вносит ("Marketing", "Supply chain").
groupenum
Для "list": по какой оси сворачиваются карточки. По умолчанию "okr" - это ось, которая отвечает на вопрос: «работает ли всё, что мы делаем, на то, о чём мы договорились?»
guardrail_notestring
Для ключевых результатов: как к этому числу можно прийти неправильным путём.
guards_idstring
Для ключевых результатов: делает этот ключевой результат ОГРАНИЧИТЕЛЕМ того ключевого результата.
idstring
Идентификатор объекта для чтения или изменения: проект для "get" и "update", цель для "update_objective", ключевой результат для "update_key_result".
impactenum
Ожидаемое влияние как оценка: 1 низкое, 2 некоторое, 3 явное, 4 высокое, 5 очень высокое.
key_result_idstring
Идентификатор ключевого результата, в который этот проект вносит вклад. "list" возвращает доступные для привязки элементы из key_results; передайте одно из их значений id. Не указывайте для работы, которая пока не вносит вклад ни в один ключевой результат: именно это ось OKR и делает видимым.
kindenum
Это проект с завершением или повторяющаяся повседневная работа? По умолчанию: "project".
manual_valuenumber
Для ключевых результатов: текущее значение, введённое вручную. Отображается так, как введено вручную; предпочтительнее dataset_id + value_column.
objective_idstring
Для "create_key_result": цель, к которой он относится. "objectives" перечисляет их.
ownerstring
Единственный человек, который за это отвечает.
parent_idstring
Проект, в состав которого входит этот. Проекты вкладываются не глубже трёх уровней (программа, рабочий поток, часть); перемещение, которое создало бы четвёртый уровень или цикл, отклоняется с сообщением в одно предложение. Прогресс родителя, если у родителя нет собственного прогресса, равен среднему по его дочерним элементам, и об этом сообщается.
progress_pctinteger
Прогресс в процентах, от 0 до 100, устанавливает человек. Никогда не выводится из этапов или дат.
resources_urlstring
Ссылка на то, где на самом деле ведётся работа (папка на диске, доска, документ). Только http(s).
sortenum
Для "list": порядок карточек внутри каждой группы. "board" (по умолчанию) ставит работу, вышедшую из графика, на первое место; "effort_impact" сортирует по impact (от 5 к 1), затем по effort (сначала меньше дней), работа без оценки идёт последней. Сводный балл не рассчитывается.
spent_amountnumber
Уже потраченные деньги, введённые человеком, в budget_currency.
stageenum
Текущее состояние. Новый проект стартует в статусе "active" (выполняется); когда владелец доски включил "New projects need admin approval", новый проект пользователя без прав администратора стартует в "inbox" (ожидает проверки), и только администратор выводит его оттуда. "long_list" = согласован, но не начат; "done" = завершён.
started_atstring
Дата начала YYYY-MM-DD
starts_onstring
Для целей: начало окна, относительно которого рассчитывается темп их ключевых результатов, YYYY-MM-DD.
statusenum
Светофор, который выставляет человек: в графике, под угрозой, вне графика.
targetnumber
Для ключевых результатов: число, которое засчитывается как выполненное. Обязательно при создании.
target_datestring
Целевая дата, YYYY-MM-DD. "Осталось N дней" / "просрочено на N дней" вычисляется из неё при каждом чтении и никогда не хранится.
target_reasonstring
Для «update_key_result»: почему цель сдвигается (десять символов или больше). Обязательно, когда меняется target; изменение сохраняется в истории ключевого результата.
titlestring
Название проекта. Обязательно для "create".
unitstring
Для ключевых результатов: единица измерения, в которой указано число.
value_columnstring
Для ключевых результатов: столбец dataset_id, в котором хранится число.