[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fcatalog-products\u002Faggregate":3,"docs-tabs-entities\u002Fcatalog-products\u002Faggregate":6},{"content":4,"lastmod":5},"\n## Агрегация товаров\n\n`POST \u002Fv1\u002Fcatalog-products\u002Faggregate`\n\nПодсчёт количества и числовые агрегации (сумма, среднее, минимум, максимум) по товарам каталога с фильтрацией и группировкой через `groupBy`.\n\n**Поля, доступные для агрегации:**\n\n- `purchasingPrice`\n- `quantity`\n- `iblockSectionId`\n\n## Поля запроса (body)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `filter` | object | да | Фильтрация по полям товара. Ключ `iblockId` обязателен — каталог из [`GET \u002Fv1\u002Fcatalogs`](\u002Fdocs\u002Fentities\u002Fcatalogs).\u003Cbr>[Синтаксис фильтрации](\u002Fdocs\u002Ffiltering) |\n| `aggregate` | array | нет | Агрегации: `[{ \"field\": \"purchasingPrice\", \"function\": \"sum\" }]`. Функции: `sum`, `avg`, `min`, `max`, `count`. Для `count` поле — `\"*\"`. Без параметра — только `count` |\n| `groupBy` | string \\| string[] | нет | Поле или массив полей для группировки (до 5). Значения — из списка выше |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcatalog-products\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"filter\": { \"iblockId\": 25 },\n    \"aggregate\": [\n      { \"field\": \"purchasingPrice\", \"function\": \"sum\" },\n      { \"field\": \"purchasingPrice\", \"function\": \"avg\" }\n    ],\n    \"groupBy\": \"iblockSectionId\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcatalog-products\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\": { \"iblockId\": 25 },\n    \"aggregate\": [\n      { \"field\": \"purchasingPrice\", \"function\": \"sum\" },\n      { \"field\": \"purchasingPrice\", \"function\": \"avg\" }\n    ],\n    \"groupBy\": \"iblockSectionId\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcatalog-products\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: { iblockId: 25 },\n    aggregate: [\n      { field: 'purchasingPrice', function: 'sum' },\n      { field: 'purchasingPrice', function: 'avg' },\n    ],\n    groupBy: 'iblockSectionId',\n  }),\n})\n\nconst { success, data } = await res.json()\nconsole.log(data.groups)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fcatalog-products\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: { iblockId: 25 },\n    aggregate: [\n      { field: 'purchasingPrice', function: 'sum' },\n      { field: 'purchasingPrice', function: 'avg' },\n    ],\n    groupBy: 'iblockSectionId',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\nДля группировки по нескольким полям передайте массив: `\"groupBy\": [\"iblockSectionId\", \"quantity\"]` (максимум 5 полей).\n\n## Другие сценарии\n\nПодсчёт записей — `count` с полем `\"*\"`, самый быстрый запрос без выгрузки записей. Для каталога обязателен фильтр `iblockId`:\n\n```json\n{ \"aggregate\": [{ \"field\": \"*\", \"function\": \"count\" }], \"filter\": { \"iblockId\": 25 } }\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data.count` | number | Общее количество товаров, соответствующих фильтру |\n| `data.aggregates` | object | Результаты агрегаций: `{ \"purchasingPrice\": { \"sum\": 0, \"avg\": 0 } }` |\n| `data.groups` | array | Группы — присутствуют только при `groupBy`. Каждый элемент: поля группировки + `count` + `aggregates` |\n| `data.meta.totalRecords` | number | Общее количество записей |\n| `data.meta.recordsProcessed` | number | Количество обработанных записей (до 5000). Для запроса без числовых функций — `0` |\n| `data.meta.truncated` | boolean | `true`, если записей больше 5000 — агрегация по первым 5000 |\n| `data.meta.groupTotal` | number | Количество групп. Присутствует только при `groupBy` |\n| `data.meta.groupsTruncated` | boolean | `true`, если число групп было ограничено. Присутствует только при `groupBy` |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 19,\n    \"aggregates\": {\n      \"purchasingPrice\": { \"sum\": 22120, \"avg\": 3686.67 }\n    },\n    \"groups\": [\n      {\n        \"iblockSectionId\": 19,\n        \"count\": 2,\n        \"aggregates\": { \"purchasingPrice\": { \"sum\": 0, \"avg\": 0 } }\n      },\n      {\n        \"iblockSectionId\": null,\n        \"count\": 15,\n        \"aggregates\": { \"purchasingPrice\": { \"sum\": 120, \"avg\": 60 } }\n      },\n      {\n        \"iblockSectionId\": 85,\n        \"count\": 2,\n        \"aggregates\": { \"purchasingPrice\": { \"sum\": 22000, \"avg\": 11000 } }\n      }\n    ],\n    \"meta\": {\n      \"totalRecords\": 19,\n      \"recordsProcessed\": 19,\n      \"truncated\": false,\n      \"groupTotal\": 3,\n      \"groupsTruncated\": false\n    }\n  }\n}\n```\n\nБез `groupBy` поле `data.groups` в ответе отсутствует.\n\n## Пример ответа при ошибке\n\n400 — поле вне списка доступных для агрегации:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"groupBy field 'nonexistent' is not aggregatable on this entity. Available: purchasingPrice, quantity, iblockSectionId.\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `MISSING_REQUIRED_FILTER` | Не передан обязательный фильтр `filter[iblockId]` — проверяется до вызова Битрикс24 (пример тела в сообщении) |\n| 400 | `INVALID_PARAMS` | Поле `groupBy` вне списка доступных — сообщение перечисляет допустимые |\n| 400 | `INVALID_PARAMS` | Числовая функция по неизвестному полю — `Field '\u003Cимя>' not found. Available numeric fields: ...` |\n| 400 | `INVALID_PARAMS` | Передано более 5 полей в `groupBy` |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `catalog` |\n| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**`count` обходится одним запросом, числовые функции — нет.** `count` подсчитывается за один вызов независимо от объёма выборки. Функции `sum`, `avg`, `min`, `max` загружают записи постранично — до 5000 — и считают значения на стороне сервера. Если под фильтр попадает больше 5000 записей, `meta.truncated` равен `true`, а агрегаты и группы строятся по первым 5000.\n\n**Поля для группировки и для расчёта.** В `groupBy` имеет смысл передавать `iblockSectionId` — раздел каталога. По числовым полям `purchasingPrice` и `quantity` считают `sum`, `avg`, `min`, `max`.\n\n## Смотрите также\n\n- [Список товаров](\u002Fdocs\u002Fentities\u002Fcatalog-products\u002Flist)\n- [Поиск товаров](\u002Fdocs\u002Fentities\u002Fcatalog-products\u002Fsearch)\n- [Поля товара](\u002Fdocs\u002Fentities\u002Fcatalog-products\u002Ffields)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","2026-07-14",{}]