[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fsites\u002Faggregate":3,"docs-tabs-entities\u002Fsites\u002Faggregate":6},{"content":4,"lastmod":5},"\n## Агрегация сайтов\n\n`POST \u002Fv1\u002Fsites\u002Faggregate`\n\nПодсчёт количества сайтов с учётом фильтра и группировка по категориальным полям. Поддерживает функцию `count` и группировку `groupBy`.\n\n## Поля запроса (body)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `aggregate` | array | нет | Массив агрегаций. Для сайтов осмысленна `{ \"field\": \"*\", \"function\": \"count\" }` — числовых полей-метрик для `sum`\u002F`avg`\u002F`min`\u002F`max` у сущности нет. Без параметра возвращается `count` записей с учётом фильтра |\n| `groupBy` | string \\| array | нет | Поле или поля для группировки. Допустимы только поля из `aggregatable`: `type`, `active`, `deleted`, `lang`, `tplId`, `domainId`, `createdById`, `modifiedById`. До 5 полей |\n| `groupOrderBy` | array | нет | Сортировка групп: массив `{ \"field\": \"count\" \\| \"\u003Cизмерение>\", \"direction\": \"asc\" \\| \"desc\" }`. Работает только вместе с `groupBy` |\n| `groupLimit` | number | нет | Ограничение числа возвращаемых групп (1..1000). Работает только вместе с `groupBy` |\n| `filter` | object | нет | Фильтрация по ключевым полям сайта.\u003Cbr>[Синтаксис фильтрации](\u002Fdocs\u002Ffiltering) |\n| `scope` | string | нет | Внутренняя область лендингов: `KNOWLEDGE` \u002F `GROUP` \u002F `MAINPAGE`. Без параметра подсчитываются обычные сайты-лендинги |\n\n> **Фильтр по типу и область (`scope`).** Если вы передали `{\"filter\": {\"type\": \"KNOWLEDGE\"}}` или `\"GROUP\"` без `scope`, Вайбкод сам подставит соответствующую область (`type=KNOWLEDGE` → `scope=KNOWLEDGE`) — подсчёт баз знаний и страниц групп работает без ручного указания `scope`, как в списке и поиске. Явный `scope` в приоритете. `MAINPAGE` — область, а не тип сайта (её сайты имеют тип `VIBE`), поэтому из фильтра по типу не выводится: для главных страниц передавайте `scope=MAINPAGE` явно.\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fsites\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"groupBy\": \"type\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fsites\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"groupBy\": \"type\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fsites\u002Faggregate', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    groupBy: 'type',\n  }),\n})\n\nconst { success, data } = await res.json()\nconsole.log('Сайтов по типу:', data.groups)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fsites\u002Faggregate', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    groupBy: 'type',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Другие сценарии\n\nОбщее количество сайтов в портале — самый быстрый запрос, без выгрузки записей:\n\n```json\n{}\n```\n\nКоличество активных сайтов-лендингов:\n\n```json\n{ \"filter\": { \"type\": \"PAGE\", \"active\": true } }\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data.count` | number | Количество сайтов, соответствующих фильтру |\n| `data.aggregates` | object | Результаты числовых агрегаций. Для сайтов остаётся пустым — нет числовых полей-метрик |\n| `data.groups` | array | Присутствует при `groupBy`. Каждый элемент — значение измерения плюс `count` записей в группе |\n| `data.meta.totalRecords` | number | Общее количество записей |\n| `data.meta.recordsProcessed` | number | Количество обработанных записей |\n| `data.meta.truncated` | boolean | Был ли результат ограничен (`true` при более 5000 записей) |\n| `data.meta.groupTotal` | number | Присутствует при `groupBy` — количество групп |\n| `data.meta.groupsTruncated` | boolean | Присутствует при `groupBy`. `true`, если число групп превысило лимит и список групп усечён |\n\n## Пример ответа\n\nГруппировка по типу (`groupBy: \"type\"`):\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 18,\n    \"aggregates\": {},\n    \"groups\": [\n      { \"type\": \"PAGE\", \"count\": 11, \"aggregates\": {} },\n      { \"type\": \"STORE\", \"count\": 5, \"aggregates\": {} },\n      { \"type\": \"VIBE\", \"count\": 2, \"aggregates\": {} }\n    ],\n    \"meta\": {\n      \"totalRecords\": 18,\n      \"recordsProcessed\": 18,\n      \"truncated\": false,\n      \"groupTotal\": 3,\n      \"groupsTruncated\": false\n    }\n  }\n}\n```\n\nПростой подсчёт без группировки (`{}`):\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 18,\n    \"aggregates\": {},\n    \"meta\": {\n      \"totalRecords\": 18,\n      \"recordsProcessed\": 0,\n      \"truncated\": false\n    }\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n400 — поле вне списка `aggregatable`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"groupBy field 'title' is not aggregatable on this entity. Available: type, active, deleted, lang, tplId, domainId, createdById, modifiedById.\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | Поле `groupBy` вне списка `aggregatable` или неизвестная функция агрегации |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `landing` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Группировка считается по выборке.** При более 5000 записей (`meta.truncated: true`) счётчики групп основаны на выборке из 5000 записей, а верхний `count` остаётся точным общим числом по фильтру.\n\n**Видимость по правам пользователя.** В подсчёт попадают только те сайты, к которым у владельца API-ключа есть право «просмотр». Если ожидается ненулевой результат, но `count` равен нулю — проверьте права пользователя, под которым выпущен ключ.\n\n## Смотрите также\n\n- [Список сайтов](\u002Fdocs\u002Fentities\u002Fsites\u002Flist) — `total` в ответе даёт точное число записей\n- [Поиск сайтов](\u002Fdocs\u002Fentities\u002Fsites\u002Fsearch) — POST-запрос с фильтрами\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization) — rate limits\n","2026-07-21",{}]