Агрегация дел

POST /v1/activities/aggregate

Подсчёт количества дел с фильтрацией и группировкой.

Агрегации по делам нужен сужающий фильтр. Битрикс24 не успевает посчитать все дела аккаунта за отведённое на вызов время, поэтому запрос без сужения на большом аккаунте не отвечает вообще — сколько бы раз его ни повторяли. Достаточно одного из трёх сужений: пара ownerTypeId + ownerId, либо responsibleId, либо граница по дате на createdAt / updatedAt / deadline. Актуальный список сужений и то, требует ли их аккаунт прямо сейчас, — в data.aggregateFilterRequirement ответа GET /v1/activities/fields.

Стандартные поля:

• typeId — тип активности (для groupBy)
• ownerTypeId — тип родительской сущности (для groupBy)
• responsibleId — ответственный (для groupBy)
• completed — статус выполнения (для groupBy)

Все поля в aggregatable — категориальные идентификаторы, поэтому основной сценарий — count с группировкой. Числовые функции sum/avg/min/max применяются редко.

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

Примеры

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

Количество дел по сделке (ownerTypeId: 2 — сделка), сгруппированное по типу активности:

curl -X POST "https://vibecode.bitrix24.tech/v1/activities/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "ownerTypeId": 2, "ownerId": 741, "completed": "Y" },
    "groupBy": "typeId"
  }'

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

curl -X POST "https://vibecode.bitrix24.tech/v1/activities/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "ownerTypeId": 2, "ownerId": 741, "completed": "Y" },
    "groupBy": "typeId"
  }'

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/activities/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { ownerTypeId: 2, ownerId: 741, completed: 'Y' },
    groupBy: 'typeId',
  }),
})

const { success, data } = await res.json()
console.log('Всего завершённых дел по сделке:', data.count)
console.log('Распределение по типу:', data.groups)

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/activities/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { ownerTypeId: 2, ownerId: 741, completed: 'Y' },
    groupBy: 'typeId',
  }),
})

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

Для группировки по нескольким полям передайте массив: "groupBy": ["typeId", "completed"] (максимум 5).

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

Количество дел за период — граница по дате считается сужением:

{
  "filter": { ">=createdAt": "2026-07-01", "<createdAt": "2026-08-01" }
}

Количество дел на сотруднике:

{
  "filter": { "responsibleId": 12 }
}

Группировка дел по контакту (ownerTypeId: 3) по статусу выполнения:

{
  "filter": { "ownerTypeId": 3, "ownerId": 485 },
  "groupBy": "completed"
}

Поля ответа

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

Ответ на основной запрос (groupBy: "typeId"):

{
  "success": true,
  "data": {
    "count": 2600,
    "aggregates": {},
    "groups": [
      { "typeId": 1, "count": 1200 },
      { "typeId": 2, "count": 800 },
      { "typeId": 6, "count": 600 }
    ],
    "meta": {
      "totalRecords": 2600,
      "recordsProcessed": 2600,
      "truncated": false
    }
  }
}

Без groupBy поле data.groups в ответе отсутствует.

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

400 — groupBy по неаггрегируемому полю или несуществующему полю:

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupBy field 'subject' is not aggregatable on this entity. Available: typeId, ownerTypeId, responsibleId, completed"
  }
}

Ошибки

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

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

Универсальный ownerTypeId. Для счётчиков по родительской сущности используйте пары ownerTypeId + ownerId: 2 — сделка, 3 — контакт, 4 — компания, 1 — лид. Это самый частый сценарий для /v1/activities/aggregate.

Почему сужений именно три. Это те поля, по которым у таблицы дел есть индекс, начинающийся с самого поля: OWNER_ID+OWNER_TYPE_ID, RESPONSIBLE_ID, CREATED, LAST_UPDATED, DEADLINE. authorId, editorId, providerTypeId индекса не имеют вовсе, а completed, typeId, providerId, direction и status слишком малоразнообразны — одно значение по-прежнему покрывает почти весь аккаунт. Границы по startTime и endTime сами сужением не считаются, но их можно ставить рядом с настоящим сужением.

Требование включается платформой отдельно на каждый аккаунт. Пока оно выключено, запрос без сужения по-прежнему уходит в Битрикс24 и на маленьком аккаунте отвечает как раньше. На большом он вернётся с 422. Проверить состояние: data.aggregateFilterRequirement.enforcement в ответе GET /v1/activities/fields — enforced (требование включено) или advisory (пока только рекомендация).

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

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

• Список дел
• Поиск дел
• Синтаксис фильтрации
• Лимиты и оптимизация