## Агрегация головных товаров

`POST /v1/catalog-skus/aggregate`

Подсчёт количества головных товаров товарного каталога с фильтрацией и группировкой по разделам через `groupBy`.

Поля `dateCreate`, `timestampX`, `dateActiveFrom` и `dateActiveTo` не принимаются в `filter`: запрос возвращает `400 UNKNOWN_FILTER_FIELD` до обращения к Битрикс24. Отбора по периоду у агрегата нет — считайте его на своей стороне по записям списка, где эти даты доступны в `select` и приходят в ответе.

**Стандартные поля.** Для группировки доступно одно поле — `iblockSectionId`, раздел каталога. Числовые функции `sum`, `avg`, `min`, `max` принимают поля с типом `number`, но у головного товара это идентификаторы, `sort` и `type`, поэтому основной сценарий раздела — подсчёт `count` с группировкой.

## Поля запроса (body)

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `filter` | object | да | Фильтрация по полям головного товара. Ключ `iblockId` обязателен — товарный каталог из [`GET /v1/catalogs`](/docs/entities/catalogs). Ключ `type` принимает одно точное число `3` или `6`.<br>[Синтаксис фильтрации](/docs/filtering) |
| `aggregate` | array | нет | Агрегации: `[{ "field": "*", "function": "count" }]`. Функции: `count`, `sum`, `avg`, `min`, `max`. Для `count` поле — `"*"`. Без параметра — только `count` |
| `groupBy` | string \| string[] | нет | Поле или массив полей для группировки (до 5). Допустимое значение — `iblockSectionId` |

## Примеры

### curl — личный ключ

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-skus/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25 },
    "aggregate": [{ "field": "*", "function": "count" }],
    "groupBy": "iblockSectionId"
  }'
```

### curl — OAuth-приложение

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-skus/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25 },
    "aggregate": [{ "field": "*", "function": "count" }],
    "groupBy": "iblockSectionId"
  }'
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-skus/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25 },
    aggregate: [{ field: '*', function: 'count' }],
    groupBy: 'iblockSectionId',
  }),
})

const { success, data } = await res.json()
console.log(data.groups)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-skus/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25 },
    aggregate: [{ field: '*', function: 'count' }],
    groupBy: 'iblockSectionId',
  }),
})

const { success, data } = await res.json()
```

## Другие сценарии

Блоки ниже — тела запросов.

Подсчёт головных товаров без группировки — самый быстрый запрос, записи не выгружаются:

```json
{ "filter": { "iblockId": 25 } }
```

Подсчёт головных товаров без вариаций — `type` равен `6`:

```json
{ "filter": { "iblockId": 25, "type": 6 } }
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.count` | number | Общее количество головных товаров, соответствующих фильтру |
| `data.aggregates` | object | Результаты числовых функций по полям: `{ "sort": { "max": 500 } }`. Без числовых функций — пустой объект |
| `data.groups` | array | Группы — присутствуют только при `groupBy`. Каждый элемент: поля группировки + `count` + `aggregates` |
| `data.meta.totalRecords` | number | Общее количество записей |
| `data.meta.recordsProcessed` | number | Количество обработанных записей (до 5000). Для запроса без `groupBy` и числовых функций — `0` |
| `data.meta.truncated` | boolean | `true`, если группы или числа посчитаны не по всем записям под фильтр: прочитано меньше записей, чем обещал `data.count` — в том числе когда под фильтр попало больше 5000, — либо срез оборвался ошибкой подстраницы. Размер нехватки приходит в `data.meta.recordsShortfall`, оборванный срез — в `data.meta.pageErrorSample`. Присутствует всегда, на полном ответе равен `false`. Если в запросе нет ни `groupBy`, ни числовых функций, записи не выгружаются и флаг всегда `false` |
| `data.meta.groupTotal` | number | Количество групп. Присутствует только при `groupBy` |
| `data.meta.groupsTruncated` | boolean | `true`, если число групп было ограничено. Присутствует только при `groupBy` |

## Пример ответа

```json
{
  "success": true,
  "data": {
    "count": 14,
    "aggregates": {},
    "groups": [
      { "iblockSectionId": null, "count": 11, "aggregates": {} },
      { "iblockSectionId": 85, "count": 1, "aggregates": {} },
      { "iblockSectionId": 19, "count": 2, "aggregates": {} }
    ],
    "meta": {
      "totalRecords": 14,
      "recordsProcessed": 14,
      "truncated": false,
      "groupTotal": 3,
      "groupsTruncated": false
    }
  }
}
```

Без `groupBy` поле `data.groups` в ответе отсутствует.

## Пример ответа при ошибке

400 — поле вне списка доступных для группировки:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupBy field 'nonexistent' is not aggregatable on this entity. Available: iblockSectionId."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_FILTER` | Не передан обязательный фильтр `filter.iblockId` — проверяется до вызова Битрикс24 (пример тела в сообщении) |
| 400 | `UNKNOWN_FILTER_FIELD` | Неизвестное поле фильтра или поле даты: `dateCreate`, `timestampX`, `dateActiveFrom`, `dateActiveTo`. Сообщение содержит список доступных полей |
| 400 | `UNSUPPORTED_FILTER` | Ключ `filter.type` передан не одним числом `3` или `6` |
| 400 | `INVALID_PARAMS` | Поле `groupBy` вне списка доступных — сообщение перечисляет допустимые |
| 400 | `INVALID_PARAMS` | Числовая функция по полю, которого нет среди числовых полей головного товара, — сообщение перечисляет их: `Field '<имя>' not found. Available numeric fields: ...` |
| 400 | `INVALID_PARAMS` | Неизвестная функция — `Invalid aggregate function '<имя>'. Supported: count, sum, avg, min, max` |
| 400 | `INVALID_PARAMS` | Передано более 5 полей в `groupBy` |
| 422 | `BITRIX_ERROR` | `iblockId` указывает на каталог вариаций (`productType is not allowed for this catalog`) |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `catalog` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 429 | `RATE_LIMITED` | Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке `x-ratelimit-limit` (потолок делится на реплики). Повторите после срока из заголовка `Retry-After` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**`count` обходится одним запросом, группировка и числовые функции — нет.** Запрос без `groupBy` и числовых функций подсчитывается за один вызов независимо от объёма выборки. С `groupBy` или функциями `sum`, `avg`, `min`, `max` записи загружаются постранично — до 5000 — и считаются на стороне сервера. Если под фильтр попадает больше 5000 записей, `meta.truncated` равен `true`, а группы и агрегаты строятся по первым 5000. Потолок не единственная причина такой пометки: она появляется и когда прочитано меньше записей, чем обещал `data.count`, — размер нехватки лежит в `data.meta.recordsShortfall`.

**Признак усечения приходит рядом с самим числом.** Когда ответ приходит с `meta.truncated: true`, пометка `truncated: true` стоит внутри объекта каждого поля в `data.aggregates`, у каждого элемента `data.groups`, а в `data.meta.warnings` добавляется предупреждение с кодом `AGGREGATE_TRUNCATED`. Так клиент, который читает только само число, видит, что оно посчитано по части записей. На полном ответе ни одной из этих пометок нет. Полный разбор — [Агрегация POST — потолок 5000 записей](/docs/entity-api#агрегация-post-потолок-5000-записей).

## Смотрите также

- [Список головных товаров](/docs/entities/catalog-skus/list)
- [Поиск головных товаров](/docs/entities/catalog-skus/search)
- [Поля головного товара](/docs/entities/catalog-skus/fields)
- [Синтаксис фильтрации](/docs/filtering)
- [Лимиты и оптимизация](/docs/optimization)