## Агрегация записей справочника

`POST /v1/statuses/aggregate`

Подсчёт `count` и числовые агрегации `sum`, `avg`, `min`, `max` по записям справочников CRM с фильтром. Основной сценарий — `count`: сколько записей в справочнике или под фильтром.

## Стандартные поля

Числовые функции применяются к числовым полям записи:

| Поле | Назначение |
|------|------------|
| `sort` | Порядок сортировки — `min` / `max` / `avg` дают диапазон весов |
| `id` | Идентификатор записи |
| `categoryId` | ID воронки для справочников вида `DEAL_STAGE_N` |

Поля `entityId`, `statusId`, `name`, `semantics` — категориальные. Для них доступен только `count` с фильтром. Группировка `groupBy` у справочников не поддерживается. Пользовательских полей у справочников CRM нет.

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

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `aggregate` | array | нет | Массив агрегаций вида `{ "field": "sort", "function": "min" }`. Функции: `sum`, `avg`, `min`, `max` — только по полям `sort`, `id`, `categoryId`. Без параметра возвращается `count` записей с учётом фильтра |
| `filter` | object | нет | Фильтрация по полям записи — `id`, `entityId`, `statusId`, `name`, `sort`, `semantics`, `categoryId`. Только точное равенство по одному значению. Список значений (`$in` или массив) не поддерживается ни по одному полю — такой фильтр отклоняется с `400 UNSUPPORTED_FILTER`. Считайте каждое значение отдельным вызовом или соберите вызовы в [`POST /v1/batch`](/docs/batch).<br>[Синтаксис фильтрации](/docs/filtering). Пример: `{ "entityId": "DEAL_STAGE" }` |

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/statuses/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityId": "DEAL_STAGE" }
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/statuses/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityId": "DEAL_STAGE" }
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityId: 'DEAL_STAGE' },
  }),
})

const { success, data } = await res.json()
console.log('Стадий в воронке:', data.count)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityId: 'DEAL_STAGE' },
  }),
})

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

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

Общее число записей всех справочников — `count` без фильтра:

```json
{}
```

Диапазон и среднее значение сортировки стадий воронки — числовые функции по полю `sort`:

```json
{
  "aggregate": [
    { "field": "sort", "function": "min" },
    { "field": "sort", "function": "max" },
    { "field": "sort", "function": "avg" }
  ],
  "filter": { "entityId": "DEAL_STAGE" }
}
```

Ответ на такой запрос содержит заполненный `data.aggregates`:

```json
{
  "success": true,
  "data": {
    "count": 8,
    "aggregates": {
      "sort": { "min": 10, "max": 80, "avg": 45 }
    },
    "meta": { "totalRecords": 8, "recordsProcessed": 8, "truncated": false }
  }
}
```

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

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

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

```json
{
  "success": true,
  "data": {
    "count": 8,
    "aggregates": {},
    "meta": {
      "totalRecords": 8,
      "recordsProcessed": 0,
      "truncated": false
    }
  }
}
```

С числовыми функциями поле `data.aggregates` заполняется — см. «Другие сценарии».

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

400 — числовая функция по несуществующему полю:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Field 'nope' not found. Available numeric fields: id, sort, categoryId."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Неизвестная функция — сообщение перечисляет допустимые: `count`, `sum`, `avg`, `min`, `max` |
| 400 | `INVALID_PARAMS` | Несуществующее поле в `aggregate` — сообщение перечисляет числовые поля: `id`, `sort`, `categoryId` |
| 400 | `INVALID_PARAMS` | Нечисловое поле в `sum` / `avg` / `min` / `max` — сообщение называет тип поля |
| 400 | `INVALID_PARAMS` | Передан `groupBy` — группировка у справочников недоступна |
| 400 | `UNSUPPORTED_FILTER` | В `filter` передан список значений — `$in` или массив. Сообщение называет поле и перечисляет фильтруемые: `id`, `entityId`, `statusId`, `name`, `sort`, `semantics`, `categoryId` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | Не передан API-ключ |
| 429 | `RATE_LIMITED` | Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке `x-ratelimit-limit` (потолок делится на реплики). Повторите после срока из заголовка `Retry-After` |

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

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

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

**Группировка недоступна.** Поля справочника не входят в набор группируемых, поэтому `groupBy` возвращает `400 INVALID_PARAMS`. Чтобы посчитать записи по типам справочника, вызывайте `count` с фильтром `filter[entityId]` отдельно для каждого типа.

**Признак усечения приходит рядом с самим числом.** Когда ответ приходит с `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)