Агрегация конфигураций открытых линий

POST /v1/openline-configs/aggregate

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

Группировка. groupBy принимает 2 поля: active, queueType — это aggregatable-поля из GET /v1/openline-configs/fields. Остальные поля (id, name, workTimeFrom, workTimeTo и прочие camelCase-поля ответа) в groupBy отвергаются с 400 INVALID_PARAMS — подробности в Известных особенностях.

Числовые агрегации (sum/avg/min/max) не применимы. Поля настроек открытых линий — категориальные или идентификационные. Поддерживается только функция count с field: "*".

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

Примеры

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

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

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

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

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

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

const { success, data } = await res.json()
console.log('Всего конфигураций:', data.count)
console.log('По типу очереди:', data.groups)

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

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

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

Для группировки по нескольким полям передайте массив: "groupBy": ["queueType", "active"]. Принимаются комбинации из 2 допустимых полей: active, queueType.

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

Блоки ниже — тела запросов.

Общее количество конфигураций — самый быстрый запрос, без выгрузки записей:

{}

Явная передача count через aggregate:

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

Поля ответа

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

Ответ на основной запрос (groupBy: "queueType"):

{
  "success": true,
  "data": {
    "count": 10,
    "aggregates": {},
    "groups": [
      { "queueType": "all", "count": 9, "aggregates": {} },
      { "queueType": "evenly", "count": 1, "aggregates": {} }
    ],
    "meta": {
      "totalRecords": 10,
      "recordsProcessed": 10,
      "truncated": false,
      "groupTotal": 2,
      "groupsTruncated": false
    }
  }
}

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

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

400 — функция count с неверным именем поля:

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "count aggregate requires field \"*\""
  }
}

Ошибки

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

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

Параметр filter в агрегации игнорируется. Передача {"filter": {"active": false}} не влияет на результат — метод возвращает count по всем конфигурациям портала. Для подсчёта по подмножеству используйте groupBy (например, groupBy: ["active"] разобьёт результат по признаку активности) или обрабатывайте результат POST /v1/openline-configs/search на стороне клиента.

Функция count требует field: "*". При передаче {"field": "id", "function": "count"} возвращается 400 INVALID_PARAMS. Единственный корректный формат: {"field": "*", "function": "count"}.

groupBy принимает только 2 поля из схемы Вайбкод: active, queueType. Это aggregatable-поля из ответа GET /v1/openline-configs/fields. Остальные поля (id, name, workTimeFrom, workTimeTo, queueTime, crm, ...) в groupBy отвергаются с 400 INVALID_PARAMS и сообщением «groupBy field 'X' is not aggregatable on this entity. Available: active, queueType».

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

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

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