#Агрегация продуктов CRM

POST /v1/products/aggregate

Агрегация данных: подсчёт количества, сумма, среднее, минимум, максимум. Поддерживает фильтрацию и группировку по любому полю из списка aggregatable.

Поля, доступные для агрегации:

  • price
  • sectionId
  • catalogId
  • active

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

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

#Примеры

#curl — без группировки

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/products/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregate": [
      { "field": "price", "function": "sum" },
      { "field": "price", "function": "avg" }
    ]
  }'

#curl — с группировкой по одному полю

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/products/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregate": [{ "field": "price", "function": "sum" }],
    "groupBy": "active"
  }'

#JavaScript

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

const { success, data } = await res.json()
// data.groups — массив групп по active
console.log(data.groups)

#Поля ответа

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

#Пример ответа — без группировки

JSON 
{
  "success": true,
  "data": {
    "count": 41,
    "aggregates": {
      "price": { "sum": 100000, "avg": 2439 }
    },
    "meta": {
      "totalRecords": 41,
      "recordsProcessed": 41,
      "truncated": false
    }
  }
}

#Пример ответа — с группировкой (`groupBy: "active"`)

JSON 
{
  "success": true,
  "data": {
    "count": 41,
    "aggregates": {
      "price": { "sum": 100000, "avg": 2439 }
    },
    "groups": [
      {
        "active": "Y",
        "count": 25,
        "aggregates": { "price": { "sum": 60000 } }
      },
      {
        "active": "N",
        "count": 16,
        "aggregates": { "price": { "sum": 40000 } }
      }
    ],
    "meta": {
      "totalRecords": 41,
      "recordsProcessed": 41,
      "truncated": false
    }
  }
}

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

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS Неизвестное поле агрегации или недопустимая функция
400 INVALID_PARAMS Передано более 5 полей в groupBy (максимум 5)
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Без aggregate — только count. Если не передать массив aggregate, метод вернёт только count записей с учётом фильтра.

groupBy принимает строку или массив. Для группировки по одному полю передайте строку: "groupBy": "active". Для нескольких — массив: "groupBy": ["active", "price"]. Максимум 5 полей.

Плоская структура групп. Поля группировки выводятся как прямые ключи в каждом элементе groups, не вложены: { "active": "...", "count": N, "aggregates": {...} }.

Ограничение 5000 записей. Если под фильтр попадает больше 5000 записей, meta.truncated будет true — агрегация и подсчёт групп выполняются по первым 5000 записям выборки.

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