[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fitems\u002Faggregate":3,"docs-tabs-entities\u002Fitems\u002Faggregate":6},{"content":4,"lastmod":5},"\n## Агрегация элементов\n\n`POST \u002Fv1\u002Fitems\u002F:entityTypeId\u002Faggregate`\n\nПодсчёт количества, сумма, среднее, минимум и максимум по элементам смарт-процесса с фильтрацией и группировкой. Смарт-процесс задаётся в пути через `entityTypeId` — ID типа процесса, который можно получить через [GET \u002Fv1\u002Fsmart-processes](\u002Fdocs\u002Fentities\u002Fsmart-processes\u002Flist).\n\n**Стандартные поля:**\n\n- `opportunity` — сумма элемента (числовое агрегирование имеет смысл)\n- `categoryId` — категория (для `groupBy`)\n- `assignedById` — ответственный (для `groupBy`)\n- `stageId` — стадия (для `groupBy`)\n- `createdBy` — создал (для `groupBy`)\n- `updatedBy` — последний изменил (для `groupBy`)\n\n**Пользовательские поля (UF):** имена UF-полей имеют префикс с внутренним номером типа смарт-процесса — `ufCrm\u003CtypeId>_*` (например, `ufCrm7_1652689362`). Этот номер не равен `entityTypeId` из пути — точные имена UF-полей берите из ответа [`GET \u002Fv1\u002Fitems\u002F:entityTypeId\u002Ffields`](\u002Fdocs\u002Fentities\u002Fitems\u002Ffields) или из текста ошибки `INVALID_PARAMS`, она перечисляет доступные поля портала. Типы `integer`, `double`, `money` — для числовых функций, UF любого типа — для `groupBy`. Основной источник бизнес-данных в смарт-процессах — именно UF.\n\n## Path-параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `entityTypeId` | number | да | ID типа смарт-процесса. Для пользовательских смарт-процессов — любое положительное целое из `GET \u002Fv1\u002Fsmart-processes`. Значения `1` (лиды), `2` (сделки), `3` (контакты), `4` (компании), `7` (предложения), `31` (счета) зарезервированы — используйте специализированные API: [\u002Fv1\u002Fdeals](\u002Fdocs\u002Fentities\u002Fdeals\u002Faggregate), [\u002Fv1\u002Fleads](\u002Fdocs\u002Fentities\u002Fleads\u002Faggregate) и т.д. |\n\n## Поля запроса (body)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `aggregate` | array | нет | Массив агрегаций. Каждый элемент: `{ \"field\": \"opportunity\", \"function\": \"sum\" }`. Функции: `count`, `sum`, `avg`, `min`, `max`. Для `count` поле — `\"*\"`. Без массива — только `count` |\n| `filter` | object | нет | Фильтрация по полям `GET \u002Fv1\u002Fitems\u002F:entityTypeId\u002Ffields`. [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering) |\n| `groupBy` | string \\| string[] | нет | Поле или массив полей для группировки (максимум 5). Принимает стандартные поля и UF-поля любого типа |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fitems\u002F177\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"aggregate\": [\n      { \"field\": \"opportunity\", \"function\": \"sum\" },\n      { \"field\": \"opportunity\", \"function\": \"avg\" }\n    ],\n    \"filter\": { \"categoryId\": 7 },\n    \"groupBy\": \"stageId\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fitems\u002F177\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"aggregate\": [\n      { \"field\": \"opportunity\", \"function\": \"sum\" },\n      { \"field\": \"opportunity\", \"function\": \"avg\" }\n    ],\n    \"filter\": { \"categoryId\": 7 },\n    \"groupBy\": \"stageId\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst entityTypeId = 177\n\nconst res = await fetch(`https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fitems\u002F${entityTypeId}\u002Faggregate`, {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    aggregate: [\n      { field: 'opportunity', function: 'sum' },\n      { field: 'opportunity', function: 'avg' },\n    ],\n    filter: { categoryId: 7 },\n    groupBy: 'stageId',\n  }),\n})\n\nconst { success, data } = await res.json()\nconsole.log('Всего элементов:', data.count)\nconsole.log('По стадиям:', data.groups)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst entityTypeId = 177\n\nconst res = await fetch(`https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fitems\u002F${entityTypeId}\u002Faggregate`, {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    aggregate: [\n      { field: 'opportunity', function: 'sum' },\n      { field: 'opportunity', function: 'avg' },\n    ],\n    filter: { categoryId: 7 },\n    groupBy: 'stageId',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n> Для группировки по нескольким полям передайте массив: `\"groupBy\": [\"stageId\", \"categoryId\"]` (максимум 5).\n\n## Другие сценарии\n\nПодсчёт записей — `count` с полем `\"*\"`, самый быстрый запрос без выгрузки записей. Без массива `aggregate` результат тот же:\n\n```json\n{ \"aggregate\": [{ \"field\": \"*\", \"function\": \"count\" }] }\n```\n\nРабота с пользовательскими полями (UF) — `sum` по UF + группировка по другому UF:\n\n```json\n{\n  \"aggregate\": [{ \"field\": \"ufCrm7_1741091916816\", \"function\": \"sum\" }],\n  \"groupBy\": \"ufCrm7_1652689362\"\n}\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data.count` | number | Количество элементов, соответствующих фильтру |\n| `data.aggregates` | object | Результаты агрегаций: `{ \"opportunity\": { \"sum\": 65911, \"avg\": 4707.92 } }` |\n| `data.groups` | array | Группы (только при `groupBy`). Каждый элемент: поля группировки + `count` + `aggregates` |\n| `data.meta.totalRecords` | number | Общее количество записей под фильтр |\n| `data.meta.recordsProcessed` | number | Сколько записей было фактически обработано для агрегации |\n| `data.meta.truncated` | boolean | `true`, если под фильтр попало больше 5000 записей |\n| `data.meta.groupTotal` | number | Количество групп (только при `groupBy`) |\n| `data.meta.groupsTruncated` | boolean | `true`, если список групп был усечён |\n\n## Пример ответа\n\nОтвет на основной запрос (агрегации + `groupBy: \"stageId\"`):\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 14,\n    \"aggregates\": {\n      \"opportunity\": { \"sum\": 65911, \"avg\": 4707.92 }\n    },\n    \"groups\": [\n      {\n        \"stageId\": \"DT177_7:NEW\",\n        \"count\": 8,\n        \"aggregates\": { \"opportunity\": { \"sum\": 40000 } }\n      },\n      {\n        \"stageId\": \"DT177_7:SUCCESS\",\n        \"count\": 6,\n        \"aggregates\": { \"opportunity\": { \"sum\": 25911 } }\n      }\n    ],\n    \"meta\": {\n      \"totalRecords\": 14,\n      \"recordsProcessed\": 14,\n      \"truncated\": false,\n      \"groupTotal\": 2,\n      \"groupsTruncated\": false\n    }\n  }\n}\n```\n\nБез `groupBy` поле `data.groups` в ответе отсутствует.\n\n## Пример ответа при ошибке\n\n400 — зарезервированный `entityTypeId` (для стандартных CRM-сущностей):\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_DYNAMIC_PARAM\",\n    \"message\": \"entityTypeId 2 has a dedicated API: use \u002Fv1\u002Fdeals instead\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_DYNAMIC_PARAM` | `entityTypeId` не является положительным целым или является зарезервированным (1, 2, 3, 4, 7, 31) |\n| 400 | `INVALID_PARAMS` | Некорректное имя функции, несуществующее поле или нечисловое поле в `sum`\u002F`avg`\u002F`min`\u002F`max` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Без массива `aggregate` — только `count`.** Если не передать `aggregate`, метод сделает один быстрый вызов в Битрикс24 и вернёт `count` записей под фильтр. Подходит для счётчиков на дашбордах.\n\n**Несколько агрегаций в одном запросе.** Можно объединить в одном вызове: `[{ \"field\": \"opportunity\", \"function\": \"sum\" }, { \"field\": \"opportunity\", \"function\": \"avg\" }]`.\n\n**Money-поля.** UF-поля типа `money` хранятся в формате `\"сумма|валюта\"` (`\"1500|RUB\"`) — агрегат извлекает числовую часть автоматически, складывать можно без парсинга.\n\n**Фильтрация по UF работает.** В `filter` можно передавать любые поля — стандартные и пользовательские, любого типа. Например, `{ \"filter\": { \"ufCrm7_1652689362\": 1435 } }` вернёт количество элементов с этим значением UF.\n\n**Ограничение 5000 записей.** Числовые агрегации подгружают записи постранично и считают на стороне Вайбкод. Если под фильтр попадает больше 5000 записей, результат будет помечен `meta.truncated: true` — берётся только первые 5000. Для точного количества используйте `count` (он работает на любом объёме) или сужайте фильтр.\n\n**Зарезервированные `entityTypeId`.** Значения `1` (лиды), `2` (сделки), `3` (контакты), `4` (компании), `7` (предложения), `31` (счета) обслуживаются специализированными API — используйте [\u002Fv1\u002Fdeals\u002Faggregate](\u002Fdocs\u002Fentities\u002Fdeals\u002Faggregate), [\u002Fv1\u002Fleads\u002Faggregate](\u002Fdocs\u002Fentities\u002Fleads\u002Faggregate), [\u002Fv1\u002Fcontacts\u002Faggregate](\u002Fdocs\u002Fentities\u002Fcontacts\u002Faggregate), [\u002Fv1\u002Fcompanies\u002Faggregate](\u002Fdocs\u002Fentities\u002Fcompanies\u002Faggregate), [\u002Fv1\u002Fquotes\u002Faggregate](\u002Fdocs\u002Fentities\u002Fquotes\u002Faggregate), [\u002Fv1\u002Finvoices\u002Faggregate](\u002Fdocs\u002Fentities\u002Finvoices\u002Faggregate).\n\n## Смотрите также\n\n- [Список смарт-процессов](\u002Fdocs\u002Fentities\u002Fsmart-processes\u002Flist)\n- [Список элементов](\u002Fdocs\u002Fentities\u002Fitems\u002Flist)\n- [Поиск элементов](\u002Fdocs\u002Fentities\u002Fitems\u002Fsearch)\n- [Поля смарт-процесса](\u002Fdocs\u002Fentities\u002Fitems\u002Ffields)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","2026-07-02",{}]