## Агрегация задач

`POST /v1/tasks/aggregate`

Подсчёт количества задач с фильтрацией и группировкой. Числовые функции работают по числовым полям задачи и пользовательским полям подходящих типов.

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

- `status` — статус задачи (для `groupBy`, для числовых функций смысла нет — это категориальный код). `groupBy: "status"` группирует по **фактическому сохранённому** статусу — это значение поля `status` в ответе, а не виртуальная мета-ось фильтра `filter[status]`
- `priority` — приоритет (для `groupBy`)
- `responsibleId` — ответственный (для `groupBy`, идентификатор)
- `groupId` — рабочая группа (для `groupBy`, идентификатор)

Все стандартные `aggregatable` поля — идентификаторы или категориальные коды, поэтому по ним работают `count` и `groupBy`. Для числовых функций (`sum`/`avg`/`min`/`max`) подходящие встроенные кандидаты — `timeEstimate` (оценка трудозатрат в секундах), `timeSpentInLogs` (фактически затраченное время в секундах) или пользовательские поля. В `groupBy` эти два поля не принимаются — из встроенных там доступны только четыре перечисленных выше.

> **Ограничение выборки по статусу.** Чтобы посчитать только открытые/завершённые задачи, добавьте в `filter` поле `realStatus` (фактический статус): `{"filter": {"realStatus": 2}}`. `filter[status]` здесь тоже виртуальный (мета-ось `−1/−2/−3`), а не число из ответа. Само `realStatus` — только для `filter`/`sort`, в `groupBy` его нет: для разбивки по статусу используйте `groupBy: "status"` (он группирует по фактическому статусу, см. выше).

**Пользовательские поля (UF):** UF-поля типов `integer`, `double`, `money` принимаются в числовых функциях. UF любого типа — в `groupBy`. Полный список UF-полей конкретного портала приходит в тексте ошибки `INVALID_PARAMS`, если передать несуществующее имя.

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

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `aggregate` | array | нет | Массив агрегаций. Каждый элемент: `{ "field": "timeEstimate", "function": "sum" }`. Функции: `count`, `sum`, `avg`, `min`, `max`. Для `count` поле — `"*"`. Без параметра — только `count` |
| `filter` | object | нет | Фильтрация по полям `GET /v1/tasks/fields`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `{"responsibleId": 1}` |
| `groupBy` | string \| string[] | нет | Поле или массив полей для группировки (максимум 5). Принимает UF-поля любого типа |

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregate": [
      { "field": "timeEstimate", "function": "sum" }
    ],
    "groupBy": "status"
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregate": [
      { "field": "timeEstimate", "function": "sum" }
    ],
    "groupBy": "status"
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    aggregate: [{ field: 'timeEstimate', function: 'sum' }],
    groupBy: 'status',
  }),
})

const { success, data } = await res.json()
console.log('Всего задач:', data.count)
console.log('По статусам:', data.groups)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    aggregate: [{ field: 'timeEstimate', function: 'sum' }],
    groupBy: 'status',
  }),
})

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

> Для группировки по нескольким полям передайте массив: `"groupBy": ["status", "responsibleId"]` (максимум 5).

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

Подсчёт записей — `count` с полем `"*"`, самый быстрый запрос без выгрузки записей. Без массива `aggregate` результат тот же:

```json
{ "aggregate": [{ "field": "*", "function": "count" }] }
```

Сколько задач у каждого ответственного:

```json
{ "groupBy": "responsibleId" }
```

Сумма по UF-полю числового типа в разрезе приоритета:

```json
{
  "aggregate": [{ "field": "UF_CRM_TASK_BUDGET", "function": "sum" }],
  "groupBy": "priority"
}
```

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.count` | number | Количество записей, соответствующих фильтру |
| `data.aggregates` | object | Результаты агрегаций. Без `aggregate` — пустой объект |
| `data.groups` | array | Группы (только при `groupBy`). Каждый элемент: поля группировки + `count` + `aggregates` |
| `data.meta.totalRecords` | number | Общее количество записей |
| `data.meta.recordsProcessed` | number | Сколько записей реально обработано |
| `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 | Был ли список групп ограничен `groupLimit` |

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

Ответ на основной запрос (`aggregate: [{field: "timeEstimate", function: "sum"}]` + `groupBy: "status"`):

```json
{
  "success": true,
  "data": {
    "count": 599,
    "aggregates": {
      "timeEstimate": { "sum": 54000 }
    },
    "groups": [
      { "status": 2, "count": 247, "aggregates": { "timeEstimate": { "sum": 18000 } } },
      { "status": 5, "count": 341, "aggregates": { "timeEstimate": { "sum": 32400 } } },
      { "status": 3, "count": 7,   "aggregates": { "timeEstimate": { "sum": 2400 } } },
      { "status": 4, "count": 4,   "aggregates": { "timeEstimate": { "sum": 1200 } } }
    ],
    "meta": {
      "totalRecords": 599,
      "recordsProcessed": 599,
      "truncated": false,
      "groupTotal": 4,
      "groupsTruncated": false
    }
  }
}
```

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

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

400 — несуществующее поле:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Unknown field 'noSuchField'. Available: status, priority, responsibleId, groupId, UF_CRM_TASK_BUDGET, …"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Неизвестная функция или несуществующее поле — сообщение содержит список допустимых (стандартных + UF) |
| 400 | `INVALID_PARAMS` | UF-поле нечислового типа (`string`, `enumeration`, `date`) в `sum`/`avg`/`min`/`max` — сообщение называет тип |
| 400 | `INVALID_PARAMS` | `groupBy` по стандартному полю вне списка `aggregatable` |
| 400 | `INVALID_PARAMS` | Больше 5 полей в `groupBy` |
| 400 | `INVALID_PARAMS` | Зарезервированные ключевые слова в `groupBy`: `count`, `aggregates`, `meta`, `groups` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `tasks` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

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

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

**`count` против числовых функций.** `count` считается одним вызовом и работает на любом объёме. `sum`/`avg`/`min`/`max` подгружают записи постранично (максимум 5000) и считают на стороне API. При выборках свыше 5000 — `meta.truncated: true`, агрегация по первым 5000. Для точных счётчиков на больших выборках используйте `count` или сужайте фильтр. Потолок не единственная причина такой пометки: она появляется и когда прочитано меньше записей, чем обещал `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-записей).

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

- [Список задач](./list.md)
- [Поиск задач](./search.md)
- [Поля задачи](./fields.md)
- [Синтаксис фильтрации](/docs/filtering)
- [Лимиты и оптимизация](/docs/optimization)