[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fcontacts\u002Faggregate":3,"docs-tabs-entities\u002Fcontacts\u002Faggregate":6},{"content":4,"lastmod":5},"\n## Агрегация контактов\n\n`POST \u002Fv1\u002Fcontacts\u002Faggregate`\n\nПодсчёт количества контактов с фильтрацией и группировкой.\n\n**Стандартные поля:**\n\n- `typeId` — тип контакта (для `groupBy`)\n- `sourceId` — источник (для `groupBy`)\n- `assignedById` — ответственный (для `groupBy`)\n\nВсе поля в `aggregatable` — категориальные идентификаторы, поэтому по стандартным полям работают `count` и `groupBy`. Для числовых функций (`sum`\u002F`avg`\u002F`min`\u002F`max`) используйте пользовательские поля.\n\n**Пользовательские поля (UF):** UF-поля типов `integer`, `double`, `money` — для числовых функций; UF любого типа — для `groupBy`. Полный список UF-полей конкретного портала приходит в тексте ошибки `INVALID_PARAMS`, если передать несуществующее имя.\n\n## Поля запроса (body)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `aggregate` | array | нет | Массив агрегаций. Каждый элемент: `{ \"field\": \"*\", \"function\": \"count\" }`. Без массива — только `count` |\n| `filter` | object | нет | Фильтрация по полям `GET \u002Fv1\u002Fcontacts\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\u002Fcontacts\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"filter\": { \"assignedById\": 1 },\n    \"groupBy\": \"typeId\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcontacts\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    \"filter\": { \"assignedById\": 1 },\n    \"groupBy\": \"typeId\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcontacts\u002Faggregate', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    filter: { assignedById: 1 },\n    groupBy: 'typeId',\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\u002Fcontacts\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    filter: { assignedById: 1 },\n    groupBy: 'typeId',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n> Для группировки по нескольким полям передайте массив: `\"groupBy\": [\"typeId\", \"sourceId\"]` (максимум 5).\n\n## Другие сценарии\n\nОбщее количество контактов в портале — самый быстрый запрос, без выгрузки записей:\n\n```json\n{}\n```\n\nРабота с пользовательскими полями (UF) — `sum` по UF + группировка по другому UF:\n\n```json\n{\n  \"aggregate\": [{ \"field\": \"UF_CRM_LTV\", \"function\": \"sum\" }],\n  \"groupBy\": \"UF_CRM_SEGMENT\"\n}\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data.count` | number | Общее количество записей под фильтр |\n| `data.aggregates` | object | Результаты агрегаций (для контактов обычно пустой) |\n| `data.groups` | array | Группы (только при `groupBy`). Каждый элемент: поля группировки + `count` |\n| `data.meta.totalRecords` | number | Общее количество записей под фильтр |\n| `data.meta.recordsProcessed` | number | Сколько записей обработано (для `count` — `0`, записи не выгружаются) |\n| `data.meta.truncated` | boolean | `true`, если под фильтр попало больше 5000 записей |\n\n## Пример ответа\n\nОтвет на основной запрос (`groupBy: \"typeId\"`):\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 1200,\n    \"aggregates\": {},\n    \"groups\": [\n      { \"typeId\": \"CLIENT\", \"count\": 800 },\n      { \"typeId\": \"SUPPLIER\", \"count\": 300 },\n      { \"typeId\": \"PARTNER\", \"count\": 100 }\n    ],\n    \"meta\": {\n      \"totalRecords\": 1200,\n      \"recordsProcessed\": 1200,\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\": \"groupBy field 'name' is not aggregatable on this entity. Available: typeId, sourceId, assignedById\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | `groupBy` по неаггрегируемому полю или больше 5 полей в `groupBy` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Money-поля.** UF-поля типа `money` хранятся в формате `\"сумма|валюта\"` (`\"1500|RUB\"`) — агрегат извлекает числовую часть автоматически, складывать можно без парсинга.\n\n**Фильтрация по UF работает.** В `filter` можно передавать любые поля — стандартные и пользовательские, любого типа. Например, `{ \"filter\": { \"ufCrm_1234\": \"value\" } }` вернёт количество контактов с этим значением UF.\n\n## Смотрите также\n\n- [Список контактов](\u002Fdocs\u002Fentities\u002Fcontacts\u002Flist) — получить записи с фильтрацией\n- [Поиск контактов](\u002Fdocs\u002Fentities\u002Fcontacts\u002Fsearch) — POST-запрос с фильтрами\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization) — rate limits\n","2026-06-19",{}]