Ключевые показатели

Готовые сводки, посчитанные на сервере: итоги дня или периода, задачи пользователя, выполнение KPI — своего и коллег. Один запрос заменяет десятки выборок из списков. На этих методах работают инструменты MCP-сервера get_my_day, get_my_tasks, get_my_kpi и get_team_kpi.

Примечание

Все значения считаются от имени владельца токена и с учётом его прав доступа. Даты передаются в формате YYYY-MM-DD; если дата не указана — берётся сегодняшний день в часовом поясе пользователя. Суммы — в базовой валюте аккаунта.

Headers

Во всех методах раздела:

Name Type Description
Authorization* String Bearer XXXXXX.XXXXX.XXXXX

Итоги дня

GET https://do.freshoffice.ru/dashboard/my/day

Сводка за день или период: добавленные контрагенты, задачи, сделки, счета, деньги, забытые контрагенты и KPI пользователя. Каждое значение приходит в двух вариантах: total — все записи, которые видит пользователь, и mine — записи, где он ответственный (в задачах — исполнитель или куратор).

Query Parameters

Name Type Description
date String Начало периода. По умолчанию — сегодня
date_to String Конец периода. По умолчанию — равен date (один день)
Имя Описание
period date_from, date_to — период расчёта
user id, name — владелец токена
companies_added Добавленные контрагенты: total, mine
tasks Задачи периода: scheduled_total, done_total, mine_scheduled, mine_done; просроченные — overdue_total, mine_overdue; разбивка по типам задач — by_type (type, total, done, mine, mine_done)
deals_created Созданные сделки: количество total / mine и суммы total_sum / mine_sum
invoices_issued Выставленные счета (документы, тип которых отмечен как счёт): total, total_sum, mine, mine_sum
money Движения денег: income, income_count, mine_income, expense, expense_count. Переводы между своими счетами не учитываются
forgotten_companies Забытые контрагенты — как индикатор «Забытые» в списке: контрагенты контролируемых типов без незавершённых задач с конца периода и дальше. total, mine
my_kpi KPI пользователя — те же поля, что в методе Мой KPI 
{
  "status": "success",
  "error": "",
  "code": null,
  "value": "{
    \"period\": {\"date_from\": \"2026-09-29\", \"date_to\": \"2026-09-29\"},
    \"user\": {\"id\": 37, \"name\": \"Екатерина Смирнова\"},
    \"companies_added\": {\"total\": 12, \"mine\": 3},
    \"tasks\": {\"scheduled_total\": 48, \"done_total\": 30, \"mine_scheduled\": 9, \"mine_done\": 6,
                \"overdue_total\": 14, \"mine_overdue\": 2,
                \"by_type\": [{\"type\": \"Звонок\", \"total\": 20, \"done\": 15, \"mine\": 5, \"mine_done\": 4}]},
    \"deals_created\": {\"total\": 4, \"total_sum\": 820000, \"mine\": 1, \"mine_sum\": 250000},
    \"invoices_issued\": {\"total\": 6, \"total_sum\": 410000, \"mine\": 2, \"mine_sum\": 95000},
    \"money\": {\"income\": 390000, \"income_count\": 5, \"mine_income\": 150000, \"expense\": 42000, \"expense_count\": 3},
    \"forgotten_companies\": {\"total\": 57, \"mine\": 8},
    \"my_kpi\": {\"has_kpi\": true, \"period_progress_percent\": 64, ...}
  }"
}

Мои задачи

GET https://do.freshoffice.ru/dashboard/my/tasks

Задачи пользователя на день и просроченные: те, где он исполнитель или куратор. Просроченные — срок раньше этого дня и задача не выполнена.

Query Parameters

Name Type Description
date String День. По умолчанию — сегодня
overdue_limit Int Сколько просроченных задач вернуть списком, от 1 до 100 (по умолчанию 30), сначала самые свежие. Общее число приходит всегда
Имя Описание
date День расчёта
today total, done и список tasks задач дня
overdue total — сколько всего просрочено, shown — сколько в списке, tasks — сами задачи

Поля задачи в списках: id, type, status, done, date_start, date_finish, company_id, company_name, deal_id, note, result.

Мой KPI

GET https://do.freshoffice.ru/dashboard/kpi/my

Выполнение плана KPI пользователя за период и с начала месяца.

Query Parameters

Name Type Description
date_from String Начало периода. По умолчанию — первое число месяца даты date_to
date_to String Конец периода. По умолчанию — сегодня
Имя Описание
has_kpi false, если пользователю не назначен план KPI — тогда остальных полей нет
period_progress_percent Средний процент выполнения пунктов плана за период
month_to_date_progress_percent То же с начала месяца
month_to_date date_from, date_to — период «с начала месяца»
month_items Пункты плана с начала месяца: name, measure (count — количество, amount — сумма), plan (план, пересчитанный на период), actual, progress_percent

KPI сотрудников и отделов

GET https://do.freshoffice.ru/dashboard/kpi/team

Процент выполнения KPI по сотрудникам и отделам — от лучших к отстающим. В ответ попадают только сотрудники и отделы, у которых есть план KPI.

Важно

Нужны права на отчёты «KPI пользователей» и/или «KPI отделов». Без обоих метод отвечает ошибкой с кодом 403. Если есть только одно право, второй список придёт пустым (null), а причина — в поле users_access или departments_access.

Query Parameters

Name Type Description
date_from String Начало периода. По умолчанию — первое число месяца даты date_to
date_to String Конец периода. По умолчанию — сегодня
department_id Int Только сотрудники этого отдела. Список отделов при этом не возвращается
Имя Описание
period date_from, date_to
users Сотрудники: user_id, name, department_id, department, progress_percent
users_access ok или причина, по которой списка нет
departments Отделы: department_id, name, progress_percent
departments_access ok или причина, по которой списка нет

progress_percent — среднее выполнение пунктов плана за период: месячный план пересчитывается на период, каждый пункт учитывается не больше чем на 100%.

Пример

curl --location --request GET 'https://do.freshoffice.ru/dashboard/my/day?date=2026-09-22&date_to=2026-09-28' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX'
Предыдущая
Пользователи
Следующая
Фильтры