For AI agents: markdown of this page — /docs-content-en/entities/leads/aggregate.md documentation index — /llms.txt

Aggregate leads

POST /v1/leads/aggregate

Count, sum, average, minimum and maximum over leads with filtering and grouping.

Standard fields:

  • opportunity — amount, canonical name, alias amount. Numeric functions and groupBy
  • stageId — status, canonical name, alias statusId. For groupBy
  • sourceId — source. For groupBy
  • assignedById — assignee. For groupBy

User fields (UF): UF fields of type integer, double, money — for numeric functions; UF of any type — for groupBy. The full list of UF fields for a specific Bitrix24 account is returned in the INVALID_PARAMS error message if you pass a non-existent name.

Request fields (body)

Parameter Type Required Description
aggregate array no Array of aggregations. Each element: { "field": "amount", "function": "sum" }. Functions: count, sum, avg, min, max. For count, the field is "*". Without the array — only count
filter object no Filtering by GET /v1/leads/fields fields. Filter syntax
groupBy string | string[] no Field or array of fields to group by (maximum 5). Allowed values — from the list above

Examples

curl — personal key

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/leads/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregate": [
      { "field": "amount", "function": "sum" },
      { "field": "amount", "function": "avg" }
    ],
    "filter": { "sourceId": "WEB" },
    "groupBy": "statusId"
  }'

curl — OAuth application

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/leads/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregate": [
      { "field": "amount", "function": "sum" },
      { "field": "amount", "function": "avg" }
    ],
    "filter": { "sourceId": "WEB" },
    "groupBy": "statusId"
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/leads/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    aggregate: [
      { field: 'amount', function: 'sum' },
      { field: 'amount', function: 'avg' },
    ],
    filter: { sourceId: 'WEB' },
    groupBy: 'statusId',
  }),
})

const { success, data } = await res.json()
console.log('Total leads:', data.count)
console.log('By status:', data.groups)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/leads/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    aggregate: [
      { field: 'amount', function: 'sum' },
      { field: 'amount', function: 'avg' },
    ],
    filter: { sourceId: 'WEB' },
    groupBy: 'statusId',
  }),
})

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

To group by multiple fields, pass an array: "groupBy": ["statusId", "sourceId"] (maximum 5).

Other scenarios

Count records — count with field "*", the fastest request without fetching records. Without the aggregate array the result is the same:

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

Working with user fields (UF) — sum over a UF + grouping by another UF:

JSON 
{
  "aggregate": [{ "field": "UF_CRM_BUDGET", "function": "sum" }],
  "groupBy": "UF_CRM_PRIORITY"
}

Response fields

Field Type Description
success boolean Always true on success
data.count number Total number of records matching the filter
data.aggregates object Aggregation results: { "amount": { "sum": 500000, "avg": 5000 } }
data.groups array Groups (only with groupBy). Each element: grouping fields + count + aggregates
data.meta.totalRecords number Total number of records matching the filter
data.meta.recordsProcessed number How many records were processed for numeric aggregations (maximum 5000)
data.meta.truncated boolean true if more than 5000 records matched the filter

Response example

Response to the main request (aggregations + groupBy: "statusId"):

JSON 
{
  "success": true,
  "data": {
    "count": 100,
    "aggregates": {
      "amount": { "sum": 500000, "avg": 5000 }
    },
    "groups": [
      {
        "statusId": "NEW",
        "count": 60,
        "aggregates": { "amount": { "sum": 300000 } }
      },
      {
        "statusId": "CONVERTED",
        "count": 40,
        "aggregates": { "amount": { "sum": 200000 } }
      }
    ],
    "meta": {
      "totalRecords": 100,
      "recordsProcessed": 100,
      "truncated": false
    }
  }
}

Without groupBy, the data.groups field is absent from the response.

Error response example

400 — invalid function name, non-existent field, or groupBy over a non-aggregatable field:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Field 'foo' not found. Available numeric fields: stageId, statusId, opportunity, amount, sourceId, assignedById"
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS Invalid function name, non-existent field, non-numeric field in sum/avg/min/max, groupBy over a non-aggregatable field, or more than 5 fields in groupBy
401 TOKEN_MISSING The API key has no configured tokens
403 SCOPE_DENIED The API key does not have the crm scope

Full list of common API errors — Errors.

Known specifics

count vs numeric functions. count counts as a single call to Bitrix24 for any data volume. The sum/avg/min/max functions load records page by page (maximum 5000) and compute on the Vibecode side — if more than 5000 records match the filter, meta.truncated will be true and the aggregation runs over the first 5000. For exact counts on large result sets, use count or narrow the filter.

Money fields. UF fields of type money are stored in the "amount|currency" format ("1500|USD") — the aggregate extracts the numeric part automatically, so you can sum them without parsing.

Filtering by UF works. In filter you can pass any fields — standard and user, of any type. For example, { "filter": { "ufCrm_1234": "value" } } returns the count of leads with that UF value.

See also