## Агрегация заказов `POST /v1/orders/aggregate` Подсчёт количества заказов и числовые агрегации (`sum`, `avg`, `min`, `max`) по полю `price`. Поддерживает фильтрацию и группировку по `statusId`, `payed`, `canceled`, `personTypeId`, `responsibleId`, `userId`. ## Стандартные поля | Поле | Назначение | |------|------------| | `price` | Единственное числовое поле — подходит для `sum` / `avg` / `min` / `max` | | `statusId` | Категориальное — используется в `groupBy` (статусы заказов) | | `payed`, `canceled` | Логические — используются в `groupBy` (оплачен / отменён) | | `personTypeId`, `responsibleId`, `userId` | Идентификаторы — используются в `groupBy` (по типу плательщика, ответственному, покупателю) | Полный список агрегируемых полей — массив `aggregatable` в [`GET /v1/orders/fields`](./fields.md). ## Поля запроса (body) | Поле | Тип | Обяз. | Описание | |------|-----|:-----:|---------| | `aggregate` | array | нет | Массив агрегаций: `[{ "field": "price", "function": "sum" }]`. Функции: `count`, `sum`, `avg`, `min`, `max`. Для `count` поле — `"*"`. Без параметра — только `count` (один запрос в Битрикс24, записи не выгружаются) | | `filter` | object | нет | Фильтрация — те же поля, что в [`GET /v1/orders`](./list.md). [Синтаксис фильтрации](/docs/filtering) | | `groupBy` | string \| string[] | нет | Поле или массив полей для группировки (максимум 5). Допустимые значения — из массива `aggregatable` | | `groupOrderBy` | array | нет | Сортировка групп: `[{ "field": "price:sum", "direction": "desc" }]`. Поля: `count`, имя измерения из `groupBy`, или `:` | | `groupLimit` | number | нет | Ограничение количества возвращаемых групп (1-1000) | ## Примеры ### curl — личный ключ ```bash curl -X POST "https://vibecode.bitrix24.tech/v1/orders/aggregate" \ -H "X-Api-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "aggregate": [ { "field": "price", "function": "sum" }, { "field": "price", "function": "avg" } ], "groupBy": "statusId" }' ``` ### curl — OAuth-приложение ```bash curl -X POST "https://vibecode.bitrix24.tech/v1/orders/aggregate" \ -H "X-Api-Key: YOUR_APP_KEY" \ -H "Authorization: Bearer USER_SESSION_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "aggregate": [ { "field": "price", "function": "sum" }, { "field": "price", "function": "avg" } ], "groupBy": "statusId" }' ``` ### JavaScript — личный ключ ```javascript const res = await fetch('https://vibecode.bitrix24.tech/v1/orders/aggregate', { method: 'POST', headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json', }, body: JSON.stringify({ aggregate: [ { field: 'price', function: 'sum' }, { field: 'price', function: 'avg' }, ], groupBy: 'statusId', }), }) const { success, data } = await res.json() // data.groups — массив групп по statusId console.log(data.groups) ``` ### JavaScript — OAuth-приложение ```javascript const res = await fetch('https://vibecode.bitrix24.tech/v1/orders/aggregate', { method: 'POST', headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Authorization': 'Bearer USER_SESSION_TOKEN', 'Content-Type': 'application/json', }, body: JSON.stringify({ aggregate: [{ field: 'price', function: 'sum' }], groupBy: 'statusId', }), }) const { success, data } = await res.json() ``` ## Другие сценарии Подсчёт записей — `count` с полем `"*"`, самый быстрый запрос без выгрузки записей. Без массива `aggregate` результат тот же: ```json { "aggregate": [{ "field": "*", "function": "count" }] } ``` Сумма по всем заказам без группировки: ```json { "aggregate": [{ "field": "price", "function": "sum" }] } ``` Топ-3 статуса по сумме заказов с сортировкой: ```json { "aggregate": [{ "field": "price", "function": "sum" }], "groupBy": "statusId", "groupOrderBy": [{ "field": "price:sum", "direction": "desc" }], "groupLimit": 3 } ``` ## Поля ответа | Поле | Тип | Описание | |------|-----|---------| | `success` | boolean | Всегда `true` при успехе | | `data.count` | number | Общее количество заказов, соответствующих фильтру | | `data.aggregates` | object | Результаты агрегаций: `{ "price": { "sum": ..., "avg": ... } }` | | `data.groups` | array | Группы (присутствует только при `groupBy`). Каждый элемент: поля группировки + `count` + `aggregates` | | `data.meta.totalRecords` | number | Общее количество записей под фильтр | | `data.meta.recordsProcessed` | number | Количество обработанных записей (до 5000) | | `data.meta.truncated` | boolean | `true`, если числа посчитаны не по всем записям под фильтр: прочитано меньше записей, чем обещал `data.count` — в том числе когда под фильтр попало больше 5000, — либо срез оборвался ошибкой подстраницы. Размер нехватки приходит в `data.meta.recordsShortfall`, оборванный срез — в `data.meta.pageErrorSample`. Присутствует всегда, на полном ответе равен `false`. Если в запросе нет ни `groupBy`, ни числовых функций, записи не выгружаются и флаг всегда `false` | | `data.meta.groupTotal` | number | Количество групп до применения `groupLimit` (только при `groupBy`) | | `data.meta.groupsTruncated` | boolean | Был ли список групп обрезан `groupLimit` | ## Пример ответа ```json { "success": true, "data": { "count": 194, "aggregates": { "price": { "sum": 2890284.0999999996 } }, "groups": [ { "statusId": "N", "count": 181, "aggregates": { "price": { "sum": 2876316.6299999994 } } }, { "statusId": "T", "count": 8, "aggregates": { "price": { "sum": 2998.5 } } }, { "statusId": "P", "count": 6, "aggregates": { "price": { "sum": 9958.97 } } }, { "statusId": "F", "count": 1, "aggregates": { "price": { "sum": 1010 } } }, { "statusId": "S", "count": 1, "aggregates": { "price": { "sum": 0 } } } ], "meta": { "totalRecords": 194, "recordsProcessed": 194, "truncated": false, "groupTotal": 5, "groupsTruncated": false } } } ``` Без `groupBy` поле `data.groups` в ответе отсутствует. ## Пример ответа при ошибке 400 — поле в `groupBy` не агрегируется: ```json { "success": false, "error": { "code": "INVALID_PARAMS", "message": "groupBy field 'foo' is not aggregatable on this entity. Available: price, statusId, payed, canceled, personTypeId, responsibleId, userId." } } ``` ## Ошибки | HTTP | Код | Описание | |------|-----|---------| | 400 | `INVALID_PARAMS` | Неизвестная функция или несуществующее поле в `aggregate` / `groupBy` — сообщение содержит список допустимых полей | | 400 | `INVALID_PARAMS` | Передано больше 5 полей в `groupBy` | | 400 | `INVALID_PARAMS` | Зарезервированные ключевые слова в `groupBy`: `count`, `aggregates`, `meta`, `groups` | | 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `sale` | | 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов | Полный список общих ошибок API — [Ошибки](/docs/errors). ## Известные особенности **`count` против числовых функций.** `count` считается одним запросом в Битрикс24 — записи не выгружаются, время ответа не зависит от количества заказов. `sum` / `avg` / `min` / `max` подгружают записи постранично (максимум 5000) и считают на стороне Вайбкод. При более чем 5000 записях `meta.truncated` будет `true`, и агрегация выполняется по первым 5000. Потолок не единственная причина такой пометки: она появляется и когда прочитано меньше записей, чем обещал `data.count`, — размер нехватки лежит в `data.meta.recordsShortfall`. **Логические поля в группировке.** `groupBy: "payed"` или `groupBy: "canceled"` возвращает группы со значениями `true` / `false`. **Признак усечения приходит рядом с самим числом.** Когда ответ приходит с `meta.truncated: true`, пометка `truncated: true` стоит внутри объекта каждого поля в `data.aggregates`, у каждого элемента `data.groups`, а в `data.meta.warnings` добавляется предупреждение с кодом `AGGREGATE_TRUNCATED`. Так клиент, который читает только само число, видит, что оно посчитано по части записей. На полном ответе ни одной из этих пометок нет. Полный разбор — [Агрегация POST — потолок 5000 записей](/docs/entity-api#агрегация-post-потолок-5000-записей). ## Смотрите также - [Список заказов](./list.md) - [Поиск заказов](./search.md) - [Поля заказа](./fields.md) - [Синтаксис фильтрации](/docs/filtering) - [Лимиты и оптимизация](/docs/optimization)