Агрегация статусов заказов

POST /v1/order-statuses/aggregate

Подсчёт количества статусов с группировкой по type или notify. Единственное числовое поле — sort, поэтому числовые функции (sum, avg) почти не нужны — основной сценарий — count с фильтром или группировкой.

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

Все поля статуса категориальные — подходят только для groupBy и filter:

Полный список агрегируемых полей перечислен в таблице выше.

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

Примеры

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

curl -X POST "https://vibecode.bitrix24.tech/v1/order-statuses/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "groupBy": "type"
  }'

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

curl -X POST "https://vibecode.bitrix24.tech/v1/order-statuses/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "groupBy": "type"
  }'

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

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

const { success, data } = await res.json()
console.log('Распределение статусов:', data.groups)

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

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

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

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

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

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

Сколько статусов с включённым уведомлением:

{
  "filter": { "notify": true }
}

Группировка по обоим осям сразу:

{
  "groupBy": ["type", "notify"]
}

Поля ответа

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

{
  "success": true,
  "data": {
    "count": 9,
    "aggregates": {},
    "groups": [
      { "type": "O", "count": 6, "aggregates": {} },
      { "type": "D", "count": 3, "aggregates": {} }
    ],
    "meta": {
      "totalRecords": 9,
      "recordsProcessed": 9,
      "truncated": false,
      "groupTotal": 2,
      "groupsTruncated": false
    }
  }
}

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

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

400 — неизвестное поле в groupBy:

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupBy field 'foo' is not aggregatable on this entity. Available: type, notify."
  }
}

Ошибки

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

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

Практически нужен только count. Единственное числовое поле статуса — sort, и только его принимают функции sum / avg / min / max; по любому другому полю они отвечают 400 INVALID_PARAMS. Для подсчёта статусов используйте count (без aggregate) с фильтром или группировкой.

Малый объём данных. На порталах число статусов измеряется десятками, поэтому потолок в 5000 записей для этой сущности не достигается.

Признак усечения приходит рядом с самим числом. Когда ответ приходит с meta.truncated: true, пометка truncated: true стоит внутри объекта каждого поля в data.aggregates, у каждого элемента data.groups, а в data.meta.warnings добавляется предупреждение с кодом AGGREGATE_TRUNCATED. Так клиент, который читает только само число, видит, что оно посчитано по части записей. На полном ответе ни одной из этих пометок нет. Полный разбор — Агрегация POST — потолок 5000 записей.

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

• Список статусов
• Поиск статусов
• Поля статуса
• Синтаксис фильтрации
• Лимиты и оптимизация