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

POST /v1/deals/aggregate

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

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

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

#Примеры

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

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

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/deals/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": { "stageId": "NEW" }
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/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: { stageId: 'NEW' },
  }),
})

const { success, data } = await res.json()
console.log('Количество:', data.count)
console.log('Сумма:', data.aggregates.amount.sum)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/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: { stageId: 'NEW' },
  }),
})

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

#Поля ответа

Поле Тип Описание
count number Количество записей, соответствующих фильтру
aggregates object Результаты: { "amount": { "sum": 150000, "avg": 5000 } }
meta.totalRecords number Общее количество записей
meta.recordsProcessed number Количество обработанных записей
meta.truncated boolean Результат обрезан

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

JSON 
{
  "success": true,
  "data": {
    "count": 311,
    "aggregates": {
      "amount": {
        "sum": 0,
        "avg": 0
      }
    },
    "meta": {
      "totalRecords": 311,
      "recordsProcessed": 0,
      "truncated": false
    }
  }
}

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

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

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

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

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

Несколько функций: в одном запросе можно запросить несколько агрегаций: [{ "field": "amount", "function": "sum" }, { "field": "amount", "function": "avg" }].

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