#Агрегация сайтов

POST /v1/sites/aggregate

Подсчёт количества сайтов с учётом фильтра. Поддерживает функцию count.

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

Параметр Тип Обяз. Описание
aggregate array нет Массив агрегаций. Для сайтов поддерживается только { "field": "*", "function": "count" } — другие функции вернут пустой aggregates (нет числовых полей в aggregatable). Без параметра — count записей с учётом фильтра
filter object нет Фильтрация по ключевым полям сайта.
Синтаксис фильтрации

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/sites/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "type": "PAGE", "active": true }
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/sites/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "type": "PAGE", "active": true }
  }'

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

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

const { success, data } = await res.json()
console.log('Активных лендингов:', data.count)

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

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

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

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

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

JSON 
{}

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.count number Количество сайтов, соответствующих фильтру
data.aggregates object Результаты агрегаций. Для сайтов остаётся пустым: схема сущности не объявляет числовых полей в aggregatable
data.meta.totalRecords number Общее количество записей
data.meta.recordsProcessed number Количество обработанных записей
data.meta.truncated boolean Был ли результат ограничен (true при более 5000 записей)

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

JSON 
{
  "success": true,
  "data": {
    "count": 18,
    "aggregates": {},
    "meta": {
      "totalRecords": 18,
      "recordsProcessed": 18,
      "truncated": false
    }
  }
}

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

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

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

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS Невалидное имя функции агрегации или несуществующее поле
403 SCOPE_DENIED API-ключ не имеет скоупа landing
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Видимость по правам пользователя. В подсчёт попадают только те сайты, к которым у владельца API-ключа есть право «просмотр». Если ожидается ненулевой результат, но count равен нулю — проверьте права пользователя, под которым выпущен ключ.

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