[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fpages\u002Faggregate":3,"docs-tabs-entities\u002Fpages\u002Faggregate":6},{"content":4,"lastmod":5},"\n## Агрегация страниц\n\n`POST \u002Fv1\u002Fpages\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`: `siteId`, `active`, `deleted`, `public`, `folderId`, `tplId`, `createdById`, `modifiedById`. До 5 полей |\n| `filter` | object | нет | Фильтрация по полям страницы.\u003Cbr>[Синтаксис фильтрации](\u002Fdocs\u002Ffiltering). Пример: `{ \"siteId\": 12 }` |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fpages\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"groupBy\": \"siteId\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fpages\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\": \"siteId\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fpages\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: 'siteId',\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\u002Fpages\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: 'siteId',\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\": { \"siteId\": 12 } }\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: \"siteId\"`):\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 84,\n    \"aggregates\": {},\n    \"groups\": [\n      { \"siteId\": 12, \"count\": 9, \"aggregates\": {} },\n      { \"siteId\": 14, \"count\": 6, \"aggregates\": {} },\n      { \"siteId\": 27, \"count\": 11, \"aggregates\": {} }\n    ],\n    \"meta\": {\n      \"totalRecords\": 84,\n      \"recordsProcessed\": 84,\n      \"truncated\": false,\n      \"groupTotal\": 5,\n      \"groupsTruncated\": false\n    }\n  }\n}\n```\n\nПростой подсчёт без группировки (`{}`):\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 84,\n    \"aggregates\": {},\n    \"meta\": {\n      \"totalRecords\": 84,\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: siteId, active, deleted, public, folderId, tplId, 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\u002Fpages\u002Flist)\n- [Поиск страниц](\u002Fdocs\u002Fentities\u002Fpages\u002Fsearch)\n- [Поля страницы](\u002Fdocs\u002Fentities\u002Fpages\u002Ffields)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n","2026-06-26",{}]