## Site aggregation

`POST /v1/sites/aggregate`

Counts sites matching a filter and groups them by categorical fields. Supports the `count` function, `groupBy` grouping and the numeric functions `sum`/`avg`/`min`/`max` over fields of type `number`.

## Request fields (body)

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `aggregate` | array | no | Array of aggregations. For sites, the meaningful aggregation is `{ "field": "*", "function": "count" }`. The `sum`/`avg`/`min`/`max` functions accept fields of type `number`, but on a site those are identifiers (`id`, `tplId`, `domainId`, `version` and others), not metrics. Without this parameter, the `count` of records matching the filter is returned |
| `groupBy` | string \| array | no | Field or fields to group by. Only fields from `aggregatable` are allowed: `type`, `active`, `deleted`, `lang`, `tplId`, `domainId`, `createdById`, `modifiedById`. Up to 5 fields |
| `groupOrderBy` | array | no | Group sorting: an array of `{ "field": "count" \| "<dimension>", "direction": "asc" \| "desc" }`. Works only together with `groupBy` |
| `groupLimit` | number | no | Limit on the number of returned groups (1..1000). Works only together with `groupBy` |
| `filter` | object | no | Filtering by the fields from `GET /v1/sites/fields`.<br>[Filtering syntax](/docs/filtering) |
| `scope` | string | no | Internal landing area: `KNOWLEDGE` / `GROUP` / `MAINPAGE`. Without this parameter, regular landing sites are counted |

> **Type filter and area (`scope`).** If you pass `{"filter": {"type": "KNOWLEDGE"}}` or `"GROUP"` without `scope`, Vibecode supplies the matching area itself (`type=KNOWLEDGE` → `scope=KNOWLEDGE`) — counting knowledge bases and group pages works without setting `scope` manually, the same way it does in list and search. An explicit `scope` wins. `MAINPAGE` is an area, not a site type (its sites have type `VIBE`), so it is not derived from the type filter: pass `scope=MAINPAGE` explicitly for home pages.

## Examples

### curl — personal key

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

### curl — OAuth application

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

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/sites/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('Sites by type:', data.groups)
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/sites/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()
```

## Other scenarios

Total number of sites in the Bitrix24 account — the fastest request, without fetching records:

```json
{}
```

Number of active landing sites:

```json
{ "filter": { "type": "PAGE", "active": true } }
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data.count` | number | Number of sites matching the filter |
| `data.aggregates` | object | Numeric aggregation results — over fields of type `number` (on a site those are identifiers, for example `tplId`). An empty object when no `aggregate` array is passed |
| `data.groups` | array | Present when `groupBy` is set. Each element is a dimension value plus the `count` of records in the group |
| `data.meta.totalRecords` | number | Total number of records |
| `data.meta.recordsProcessed` | number | How many records were processed |
| `data.meta.truncated` | boolean | `true` when the numbers were computed over only some of the records that match the filter: fewer records were read than `data.count` promised — including when more than 5000 matched the filter — or the slice was cut short by a sub-page error. The size of the gap is reported in `data.meta.recordsShortfall`, the interrupted slice in `data.meta.pageErrorSample`. Always present, and `false` on a complete response. If the request has neither `groupBy` nor a numeric function, no records are fetched and the flag is always `false` |
| `data.meta.recordsShortfall` | number | Present with `truncated: true` when fewer records were read than `data.count` promised: how many records were left out of the calculation |
| `data.meta.pageErrorSample` | object | Present with `truncated: true` when the slice was cut short by a sub-page error: the `code` and `message` of that error |
| `data.meta.warnings` | array | Present with `truncated: true`: a warning with the `AGGREGATE_TRUNCATED` code and a `message` |
| `data.meta.groupTotal` | number | Present when `groupBy` is set — the number of groups |
| `data.meta.groupsTruncated` | boolean | Present when `groupBy` is set. `true` if the number of groups exceeded the limit and the list was truncated |

## Response example

Grouping by type (`groupBy: "type"`):

```json
{
  "success": true,
  "data": {
    "count": 18,
    "aggregates": {},
    "groups": [
      { "type": "PAGE", "count": 11, "aggregates": {} },
      { "type": "STORE", "count": 5, "aggregates": {} },
      { "type": "VIBE", "count": 2, "aggregates": {} }
    ],
    "meta": {
      "totalRecords": 18,
      "recordsProcessed": 18,
      "truncated": false,
      "groupTotal": 3,
      "groupsTruncated": false
    }
  }
}
```

Plain count without grouping (`{}`):

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

## Error response example

400 — a field outside the `aggregatable` list:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupBy field 'title' is not aggregatable on this entity. Available: type, active, deleted, lang, tplId, domainId, createdById, modifiedById."
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | The `groupBy` field is outside the `aggregatable` list, or an unknown aggregation function |
| 403 | `SCOPE_DENIED` | The API key lacks the `landing` scope |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |
| 409 | `LANDING_MODULE_NOT_ENABLED` | The Sites module is unavailable on this Bitrix24 account. Ask a Bitrix24 account administrator to enable it — until then, retrying the request returns the same error |
| 429 | `RATE_LIMITED` | Rate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the `x-ratelimit-limit` header. Retry after the delay in the `Retry-After` header |

For the full list of common API errors, see [Errors](/docs/errors).

## Known specifics

**Grouping is computed over the records that were read.** When a response arrives with `meta.truncated: true`, the group counts are computed over the slice that was read, while the top-level `count` stays the exact total for the filter.

**Visibility by user permissions.** Only sites the API key owner has "view" permission for are counted. If you expect a non-zero result but `count` is zero, check the permissions of the user the key is issued for.

**The truncation marker travels with the number itself.** When a response arrives with `meta.truncated: true`, the marker `truncated: true` sits inside every field object in `data.aggregates` and on every element of `data.groups`, and `data.meta.warnings` gains a warning with the code `AGGREGATE_TRUNCATED`. A client that reads only the number itself therefore sees that it was computed over only some of the records. None of these markers appear on a complete response. For full details, see [Aggregation POST — the 5000-record ceiling](/docs/entity-api#aggregation-post-the-5000-record-ceiling).

## See also

- [List sites](/docs/entities/sites/list)
- [Search sites](/docs/entities/sites/search)
- [Filtering syntax](/docs/filtering)
- [Limits and optimization](/docs/optimization)