[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Forder-statuses\u002Faggregate":3,"docs-tabs-entities\u002Forder-statuses\u002Faggregate":6},{"content":4,"lastmod":5},"\n## Агрегация статусов заказов\n\n`POST \u002Fv1\u002Forder-statuses\u002Faggregate`\n\nПодсчёт количества статусов с группировкой по `type` или `notify`. У сущности нет числовых полей, поэтому числовые функции (`sum`, `avg`) не применяются — основной сценарий — `count` с фильтром или группировкой.\n\n## Стандартные поля\n\nВсе поля статуса категориальные — подходят только для `groupBy` и `filter`:\n\n| Поле | Назначение |\n|------|------------|\n| `type` | Группировка по типу: `O` (заказа) или `D` (доставки) |\n| `notify` | Группировка по тому, отправляется ли уведомление |\n\nПолный список агрегируемых полей перечислен в таблице выше.\n\n## Поля запроса (тело)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `aggregate` | array | нет | Массив агрегаций. Для статусов основной вариант — `count` (без других функций, числовых полей нет). Формат подсчёта — `{ \"field\": \"*\", \"function\": \"count\" }`. Без параметра — `count` записей с учётом фильтра |\n| `filter` | object | нет | Фильтрация — те же поля, что в [`GET \u002Fv1\u002Forder-statuses`](.\u002Flist.md). [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering) |\n| `groupBy` | string \\| string[] | нет | Поле или массив полей для группировки (максимум 5) |\n| `groupOrderBy` | array | нет | Сортировка групп: `[{ \"field\": \"count\", \"direction\": \"desc\" }]` |\n| `groupLimit` | number | нет | Ограничение количества возвращаемых групп (1-1000) |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Forder-statuses\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"groupBy\": \"type\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Forder-statuses\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    \"groupBy\": \"type\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Forder-statuses\u002Faggregate', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    groupBy: 'type',\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\u002Forder-statuses\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    groupBy: 'type',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Другие сценарии\n\nПодсчёт записей — `count` с полем `\"*\"`, самый быстрый запрос без выгрузки записей. Без массива `aggregate` результат тот же:\n\n```json\n{ \"aggregate\": [{ \"field\": \"*\", \"function\": \"count\" }] }\n```\n\nСколько статусов с включённым уведомлением:\n\n```json\n{\n  \"filter\": { \"notify\": true }\n}\n```\n\nГруппировка по обоим осям сразу:\n\n```json\n{\n  \"groupBy\": [\"type\", \"notify\"]\n}\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data.count` | number | Общее количество статусов, соответствующих фильтру |\n| `data.aggregates` | object | Результаты агрегаций — для статусов остаётся пустым (нет числовых полей в `aggregatable`) |\n| `data.groups` | array | Группы (только при `groupBy`) |\n| `data.meta.totalRecords` | number | Общее количество записей |\n| `data.meta.recordsProcessed` | number | Количество обработанных записей |\n| `data.meta.truncated` | boolean | `true`, если записей больше 5000 |\n| `data.meta.groupTotal` | number | Количество групп до `groupLimit` |\n| `data.meta.groupsTruncated` | boolean | Был ли список групп обрезан `groupLimit` |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 9,\n    \"aggregates\": {},\n    \"groups\": [\n      { \"type\": \"O\", \"count\": 6, \"aggregates\": {} },\n      { \"type\": \"D\", \"count\": 3, \"aggregates\": {} }\n    ],\n    \"meta\": {\n      \"totalRecords\": 9,\n      \"recordsProcessed\": 9,\n      \"truncated\": false,\n      \"groupTotal\": 2,\n      \"groupsTruncated\": 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 'foo' is not aggregatable on this entity. Available: type, notify.\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | Неизвестная функция или несуществующее поле — сообщение содержит список допустимых полей |\n| 400 | `INVALID_PARAMS` | Передано больше 5 полей в `groupBy` |\n| 400 | `INVALID_PARAMS` | Зарезервированные ключевые слова в `groupBy`: `count`, `aggregates`, `meta`, `groups` |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `sale` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Только `count` имеет смысл.** Поскольку в схеме статуса нет числовых полей в `aggregatable`, функции `sum` \u002F `avg` \u002F `min` \u002F `max` всегда возвращают пустой `aggregates`. Для подсчёта статусов используйте `count` (без `aggregate`) с фильтром или группировкой.\n\n**Малый объём данных.** На порталах число статусов измеряется десятками, поэтому `meta.truncated` (срабатывает только при > 5000 записей) для этой сущности не активируется.\n\n## Смотрите также\n\n- [Список статусов](.\u002Flist.md)\n- [Поиск статусов](.\u002Fsearch.md)\n- [Поля статуса](.\u002Ffields.md)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","2026-07-02",{}]