#Агрегация лидов

POST /v1/leads/aggregate

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

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

  • amount — предполагаемая сумма (числовое агрегирование имеет смысл)
  • statusId — статус (для groupBy)
  • sourceId — источник (для groupBy)
  • assignedById — ответственный (для groupBy)

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

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

Параметр Тип Обяз. Описание
aggregate array нет Массив агрегаций. Каждый элемент: { "field": "amount", "function": "sum" }. Функции: count, sum, avg, min, max. Без массива — только count
filter object нет Фильтрация по полям GET /v1/leads/fields. Синтаксис фильтрации
groupBy string | string[] нет Поле или массив полей для группировки (максимум 5). Допустимые значения — из списка выше

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/leads/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregate": [
      { "field": "amount", "function": "sum" },
      { "field": "amount", "function": "avg" }
    ],
    "filter": { "sourceId": "WEB" },
    "groupBy": "statusId"
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/leads/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregate": [
      { "field": "amount", "function": "sum" },
      { "field": "amount", "function": "avg" }
    ],
    "filter": { "sourceId": "WEB" },
    "groupBy": "statusId"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    aggregate: [
      { field: 'amount', function: 'sum' },
      { field: 'amount', function: 'avg' },
    ],
    filter: { sourceId: 'WEB' },
    groupBy: 'statusId',
  }),
})

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/leads/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    aggregate: [
      { field: 'amount', function: 'sum' },
      { field: 'amount', function: 'avg' },
    ],
    filter: { sourceId: 'WEB' },
    groupBy: 'statusId',
  }),
})

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

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

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

Только count — самый быстрый запрос, без выгрузки записей:

JSON 
{ "filter": { "statusId": "NEW" } }

Работа с пользовательскими полями (UF) — sum по UF + группировка по другому UF:

JSON 
{
  "aggregate": [{ "field": "UF_CRM_BUDGET", "function": "sum" }],
  "groupBy": "UF_CRM_PRIORITY"
}

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.count number Общее количество записей под фильтр
data.aggregates object Результаты агрегаций: { "amount": { "sum": 500000, "avg": 5000 } }
data.groups array Группы (только при groupBy). Каждый элемент: поля группировки + count + aggregates
data.meta.totalRecords number Общее количество записей под фильтр
data.meta.recordsProcessed number Сколько записей обработано для числовых агрегаций (максимум 5000)
data.meta.truncated boolean true, если под фильтр попало больше 5000 записей

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

Ответ на основной запрос (агрегации + groupBy: "statusId"):

JSON 
{
  "success": true,
  "data": {
    "count": 100,
    "aggregates": {
      "amount": { "sum": 500000, "avg": 5000 }
    },
    "groups": [
      {
        "statusId": "NEW",
        "count": 60,
        "aggregates": { "amount": { "sum": 300000 } }
      },
      {
        "statusId": "CONVERTED",
        "count": 40,
        "aggregates": { "amount": { "sum": 200000 } }
      }
    ],
    "meta": {
      "totalRecords": 100,
      "recordsProcessed": 100,
      "truncated": false
    }
  }
}

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

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Field 'foo' not found. Available numeric fields: statusId, amount, sourceId, assignedById"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS Невалидное имя функции, несуществующее поле, нечисловое поле в sum/avg/min/max, groupBy по неаггрегируемому полю или больше 5 полей в groupBy
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа crm

Полный список общих ошибок API — Ошибки.

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

count vs числовые функции. count считается одним вызовом в Битрикс24 на любом объёме данных. Функции sum/avg/min/max подгружают записи постранично (максимум 5000) и считают на стороне Вайбкод — если под фильтр попадает больше 5000 записей, meta.truncated будет true, агрегация выполнится по первым 5000. Для точных счётчиков на больших выборках используйте count или сужайте фильтр.

Money-поля. UF-поля типа money хранятся в формате "сумма|валюта" ("1500|RUB") — агрегат извлекает числовую часть автоматически, складывать можно без парсинга.

Фильтрация по UF работает. В filter можно передавать любые поля — стандартные и пользовательские, любого типа. Например, { "filter": { "ufCrm_1234": "value" } } вернёт количество лидов с этим значением UF.

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