Для AI-агентов: markdown этой страницы — /docs-content/humanresources/nodes/aggregate.md индекс документации — /llms.txt

Агрегация узлов

POST /v1/humanresources/nodes/aggregate

Подсчёт узлов оргструктуры выбранного типа и числовые агрегации по ним — сумма, среднее, минимум, максимум. Тип узлов передаётся внутри фильтра в теле запроса, а не в строке запроса, как у списка узлов.

Поля, доступные для числовых функций:

  • userCount — число сотрудников в узле, единственное поле, по которому числовое агрегирование имеет смысл.
  • id, structureId, parentId — идентификаторы. Функции sum, avg, min, max их принимают, но результат не несёт смысла как метрика.

Поля запроса (body)

Параметр Тип Обяз. Описание
filter object да Объект с единственным ключом type — тип узлов: DEPARTMENT (отдел) или TEAM (команда). Другие ключи фильтра не принимаются
aggregate array нет Агрегации: [{ "field": "userCount", "function": "sum" }], до 5 выражений. Функции: count, sum, avg, min, max. Для count поле — "*". Без параметра возвращается только count

Примеры

curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/humanresources/nodes/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "type": "DEPARTMENT" },
    "aggregate": [
      { "field": "userCount", "function": "sum" }
    ]
  }'

curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/humanresources/nodes/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "type": "DEPARTMENT" },
    "aggregate": [
      { "field": "userCount", "function": "sum" }
    ]
  }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { type: 'DEPARTMENT' },
    aggregate: [
      { field: 'userCount', function: 'sum' },
    ],
  }),
})

const { success, data } = await res.json()
console.log(`Отделов: ${data.count}, сотрудников в них: ${data.aggregates.userCount.sum}`)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { type: 'DEPARTMENT' },
    aggregate: [
      { field: 'userCount', function: 'sum' },
    ],
  }),
})

const { success, data } = await res.json()

Другие сценарии

Блоки ниже — тела запросов.

Количество команд — самый быстрый запрос, без выгрузки записей:

JSON 
{ "filter": { "type": "TEAM" } }

То же через явный count — поле "*", результат совпадает с запросом без aggregate:

JSON 
{ "filter": { "type": "DEPARTMENT" }, "aggregate": [{ "field": "*", "function": "count" }] }

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.count number Количество узлов выбранного типа
data.aggregates object Результаты числовых функций: { "userCount": { "sum": 55 } }. Пустой объект, если числовые функции не запрошены
data.meta.totalRecords number Общее количество записей
data.meta.recordsProcessed number Количество обработанных записей. Для запроса без числовых функций — 0
data.meta.truncated boolean true, если числа посчитаны не по всем записям под фильтр: прочитано меньше записей, чем обещал data.count — в том числе когда под фильтр попало больше 5000, — либо срез оборвался ошибкой подстраницы. Размер нехватки приходит в data.meta.recordsShortfall, оборванный срез — в data.meta.pageErrorSample. Присутствует всегда, на полном ответе равен false. Если в запросе нет числовых функций, записи не выгружаются и флаг всегда false

Пример ответа

Сумма сотрудников по всем отделам:

JSON 
{
  "success": true,
  "data": {
    "count": 20,
    "aggregates": {
      "userCount": { "sum": 55 }
    },
    "meta": {
      "totalRecords": 20,
      "recordsProcessed": 20,
      "truncated": false
    }
  }
}

Пример ответа при ошибке

400 — в filter не передан тип узлов:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_PARAMS",
    "message": "POST /v1/humanresources/nodes/aggregate requires filter params: type. Example body: { \"filter\": {\"type\":\"...\"} }"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_REQUIRED_PARAMS В filter нет ключа type, либо значение пустое или передано массивом или объектом. Тот же ответ, если type передан на верхнем уровне тела или в строке запроса
400 INVALID_PARAMS Значение type отличается от DEPARTMENT и TEAM — в validation[] приходит элемент с field: "INVALID_TYPE"
400 INVALID_PARAMS Неизвестная функция — Invalid aggregate function '<имя>'. Supported: count, sum, avg, min, max
400 INVALID_PARAMS Числовая функция по нечисловому полю — Field '<имя>' is not numeric (type: string)
400 INVALID_PARAMS Числовая функция по полю, которого нет у узлов — Field '<имя>' not found, сообщение перечисляет доступные числовые поля
400 INVALID_PARAMS Числовая функция без поля или с полем "*"
400 INVALID_PARAMS count с полем, отличным от "*"
400 INVALID_PARAMS Пустой массив aggregate или больше 5 выражений в нём
400 INVALID_PARAMS Передан groupBy — сообщение groupBy field '<имя>' is not aggregatable on this entity
422 BITRIX_ERROR В filter передан ключ помимо type, например parentId или name — сообщение о нераспознанном выражении фильтра
403 SCOPE_DENIED Ключу не хватает скоупа humanresources
401 TOKEN_MISSING У API-ключа не настроены токены Битрикс24
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

Полный список общих ошибок API — Ошибки.

Известные особенности

count обходится одним запросом, числовые функции — нет. count подсчитывается за один вызов независимо от числа узлов. Функции sum, avg, min, max загружают записи постранично — до 5000 — и считают значения на стороне сервера.

Группировка недоступна. У узлов нет полей для groupBy: запрос с любым полем группировки возвращает 400 INVALID_PARAMS с пустым списком допустимых полей. Чтобы получить отдельные числа для отделов и команд, сделайте по запросу на каждый тип или вызовите количество узлов по типам.

Признак усечения приходит рядом с самим числом. Когда ответ приходит с meta.truncated: true, пометка truncated: true стоит внутри объекта каждого поля в data.aggregates, а в data.meta.warnings добавляется предупреждение с кодом AGGREGATE_TRUNCATED. Так клиент, который читает только само число, видит, что оно посчитано по части записей. На полном ответе ни одной из этих пометок нет. Полный разбор — Агрегация POST — потолок 5000 записей.

Смотрите также