[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fdeals\u002Faggregate":3,"docs-tabs-entities\u002Fdeals\u002Faggregate":6},{"content":4,"lastmod":5},"\n## Агрегация сделок\n\n`POST \u002Fv1\u002Fdeals\u002Faggregate`\n\nПодсчёт количества, сумма, среднее, минимум и максимум по сделкам с фильтрацией и группировкой.\n\n**Стандартные поля:**\n\n- `amount` — сумма сделки (числовое агрегирование имеет смысл)\n- `stageId` — стадия (для `groupBy`)\n- `categoryId` — воронка (для `groupBy`)\n- `assignedById` — ответственный (для `groupBy`)\n- `sourceId` — источник (для `groupBy`)\n\n**Пользовательские поля (UF):** UF-поля типов `integer`, `double`, `money` — для числовых функций; UF любого типа — для `groupBy`. Полный список UF-полей конкретного портала приходит в тексте ошибки `INVALID_PARAMS`, если передать несуществующее имя.\n\n## Поля запроса (body)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `aggregate` | array | нет | Массив агрегаций. Каждый элемент: `{ \"field\": \"amount\", \"function\": \"sum\" }`. Функции: `count`, `sum`, `avg`, `min`, `max`. Для `count` поле — `\"*\"`. Без массива — только `count` |\n| `filter` | object | нет | Фильтрация по полям `GET \u002Fv1\u002Fdeals\u002Ffields`. [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering) |\n| `groupBy` | string \\| string[] | нет | Поле или массив полей для группировки (максимум 5). Допустимые значения — из списка выше |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdeals\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"aggregate\": [\n      { \"field\": \"amount\", \"function\": \"sum\" },\n      { \"field\": \"amount\", \"function\": \"avg\" }\n    ],\n    \"filter\": { \"categoryId\": 0 },\n    \"groupBy\": \"stageId\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdeals\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\": \"amount\", \"function\": \"sum\" },\n      { \"field\": \"amount\", \"function\": \"avg\" }\n    ],\n    \"filter\": { \"categoryId\": 0 },\n    \"groupBy\": \"stageId\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdeals\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: 'amount', function: 'sum' },\n      { field: 'amount', function: 'avg' },\n    ],\n    filter: { categoryId: 0 },\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 res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdeals\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: 'amount', function: 'sum' },\n      { field: 'amount', function: 'avg' },\n    ],\n    filter: { categoryId: 0 },\n    groupBy: 'stageId',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n> Для группировки по нескольким полям передайте массив: `\"groupBy\": [\"stageId\", \"sourceId\"]` (максимум 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\": \"UF_CRM_BUDGET\", \"function\": \"sum\" }],\n  \"groupBy\": \"UF_CRM_PRIORITY\"\n}\n```\n\nСводка по воронке — один запрос с группировкой по стадии и суммой даёт разбивку, из которой на стороне приложения считается конверсия в выигранные:\n\n```json\n{\n  \"aggregate\": [{ \"field\": \"amount\", \"function\": \"sum\" }],\n  \"filter\": { \"categoryId\": 0 },\n  \"groupBy\": \"stageId\"\n}\n```\n\nВ ответе `data.count` — всего сделок в воронке, `data.groups` — разбивка по стадиям с суммой и количеством. Идентификаторы стадий зависят от воронки — получить их можно из [Поля](\u002Fdocs\u002Fentities\u002Fdeals\u002Ffields). Конверсия считается из групп без отдельного запроса:\n\n```javascript\nconst total = data.count\nconst won = data.groups.find(g => g.stageId === 'WON')?.count ?? 0\nconst conversion = total ? Math.round((won \u002F total) * 100) : 0\nconsole.log(`Сделок в воронке: ${total}, выиграно: ${won}, конверсия: ${conversion}%`)\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data.count` | number | Общее количество записей под фильтр |\n| `data.aggregates` | object | Результаты агрегаций: `{ \"amount\": { \"sum\": 100000, \"avg\": 2439 } }` |\n| `data.groups` | array | Группы (только при `groupBy`). Каждый элемент: поля группировки + `count` + `aggregates` |\n| `data.meta.totalRecords` | number | Общее количество записей под фильтр |\n| `data.meta.recordsProcessed` | number | Сколько записей обработано для числовых агрегаций (максимум 5000) |\n| `data.meta.truncated` | boolean | `true`, если под фильтр попало больше 5000 записей |\n\n## Пример ответа\n\nОтвет на основной запрос (агрегации + `groupBy: \"stageId\"`):\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 41,\n    \"aggregates\": {\n      \"amount\": { \"sum\": 100000, \"avg\": 2439 }\n    },\n    \"groups\": [\n      {\n        \"stageId\": \"NEW\",\n        \"count\": 25,\n        \"aggregates\": { \"amount\": { \"sum\": 60000 } }\n      },\n      {\n        \"stageId\": \"WON\",\n        \"count\": 16,\n        \"aggregates\": { \"amount\": { \"sum\": 40000 } }\n      }\n    ],\n    \"meta\": {\n      \"totalRecords\": 41,\n      \"recordsProcessed\": 41,\n      \"truncated\": false\n    }\n  }\n}\n```\n\nБез `groupBy` поле `data.groups` в ответе отсутствует.\n\n## Пример ответа при ошибке\n\n400 — неверное имя функции, несуществующее поле или `groupBy` по неаггрегируемому полю:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"Field 'foo' not found. Available numeric fields: amount, stageId, categoryId, assignedById, sourceId\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | Невалидное имя функции, несуществующее поле, нечисловое поле в `sum`\u002F`avg`\u002F`min`\u002F`max`, `groupBy` по неаггрегируемому полю или больше 5 полей в `groupBy` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**`count` vs числовые функции.** `count` считается одним вызовом в Битрикс24 на любом объёме данных. Функции `sum`\u002F`avg`\u002F`min`\u002F`max` подгружают записи постранично (максимум 5000) и считают на стороне Вайбкод — если под фильтр попадает больше 5000 записей, `meta.truncated` будет `true`, агрегация выполнится по первым 5000. Для точных счётчиков на больших выборках используйте `count` или сужайте фильтр.\n\n**Money-поля.** UF-поля типа `money` хранятся в формате `\"сумма|валюта\"` (`\"1500|RUB\"`) — агрегат извлекает числовую часть автоматически, складывать можно без парсинга.\n\n**Фильтрация по UF работает.** В `filter` можно передавать любые поля — стандартные и пользовательские, любого типа. Например, `{ \"filter\": { \"ufCrm_1234\": \"value\" } }` вернёт количество сделок с этим значением UF.\n\n## Смотрите также\n\n- [Список сделок](\u002Fdocs\u002Fentities\u002Fdeals\u002Flist) — получить записи с фильтрацией\n- [Поиск сделок](\u002Fdocs\u002Fentities\u002Fdeals\u002Fsearch) — POST-запрос с фильтрами\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization) — rate limits\n","2026-07-02",{}]