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

Aggregate catalog products

POST /v1/catalog-products/aggregate

Counting and numeric aggregations (sum, average, minimum, maximum) over catalog products with filtering and grouping via groupBy.

The dateCreate, timestampX, dateActiveFrom, and dateActiveTo fields are not accepted in filter: the request returns 400 UNKNOWN_FILTER_FIELD before calling Bitrix24. This endpoint does not support date-range filtering. Calculate aggregates for a specific period in your integration using records from the list endpoint, where these dates are available in select and responses.

Fields available for aggregation:

  • purchasingPrice
  • quantity
  • iblockSectionId

Request fields (body)

Parameter Type Required Description
Parameterfilter Typeobject Requiredyes DescriptionFiltering by product fields. The iblockId key is required — the catalog from GET /v1/catalogs.
Filtering syntax
Parameteraggregate Typearray Requiredno DescriptionAggregations: [{ "field": "purchasingPrice", "function": "sum" }]. Functions: sum, avg, min, max, count. For count, the field is "*". Without the parameter — count only
ParametergroupBy Typestring | string[] Requiredno DescriptionField or array of fields to group by (up to 5). Values — from the list above

Examples

curl — personal key

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/catalog-products/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25 },
    "aggregate": [
      { "field": "purchasingPrice", "function": "sum" },
      { "field": "purchasingPrice", "function": "avg" }
    ],
    "groupBy": "iblockSectionId"
  }'

curl — OAuth application

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/catalog-products/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25 },
    "aggregate": [
      { "field": "purchasingPrice", "function": "sum" },
      { "field": "purchasingPrice", "function": "avg" }
    ],
    "groupBy": "iblockSectionId"
  }'

JavaScript — personal key

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

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

JavaScript — OAuth application

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

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

To group by several fields, pass an array: "groupBy": ["iblockSectionId", "quantity"] (maximum 5 fields).

Other scenarios

Count records — count with field "*", the fastest request without fetching records. For a catalog, the iblockId filter is required:

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.count Typenumber DescriptionTotal number of products matching the filter
Fielddata.aggregates Typeobject DescriptionAggregation results: { "purchasingPrice": { "sum": 0, "avg": 0 } }
Fielddata.groups Typearray DescriptionGroups — present only with groupBy. Each element: grouping fields + count + aggregates
Fielddata.meta.totalRecords Typenumber DescriptionTotal number of records
Fielddata.meta.recordsProcessed Typenumber DescriptionNumber of processed records (up to 5000). For a request without numeric functions — 0
Fielddata.meta.truncated Typeboolean Descriptiontrue 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
Fielddata.meta.groupTotal Typenumber DescriptionNumber of groups. Present only with groupBy
Fielddata.meta.groupsTruncated Typeboolean Descriptiontrue if the number of groups was limited. Present only with groupBy

Response example

JSON 
{
  "success": true,
  "data": {
    "count": 19,
    "aggregates": {
      "purchasingPrice": { "sum": 22120, "avg": 3686.67 }
    },
    "groups": [
      {
        "iblockSectionId": 19,
        "count": 2,
        "aggregates": { "purchasingPrice": { "sum": 0, "avg": 0 } }
      },
      {
        "iblockSectionId": null,
        "count": 15,
        "aggregates": { "purchasingPrice": { "sum": 120, "avg": 60 } }
      },
      {
        "iblockSectionId": 85,
        "count": 2,
        "aggregates": { "purchasingPrice": { "sum": 22000, "avg": 11000 } }
      }
    ],
    "meta": {
      "totalRecords": 19,
      "recordsProcessed": 19,
      "truncated": false,
      "groupTotal": 3,
      "groupsTruncated": false
    }
  }
}

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

Error response example

400 — a field outside the list available for aggregation:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupBy field 'nonexistent' is not aggregatable on this entity. Available: purchasingPrice, quantity, iblockSectionId."
  }
}

Errors

HTTP Code Description
HTTP400 CodeMISSING_REQUIRED_FILTER DescriptionThe required filter[iblockId] was not passed — checked before the Bitrix24 call (an example body is in the message)
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionUnknown filter field or a date field: dateCreate, timestampX, dateActiveFrom, dateActiveTo. The message contains the list of available fields
HTTP400 CodeINVALID_PARAMS DescriptionThe groupBy field is outside the available list — the message lists the allowed ones
HTTP400 CodeINVALID_PARAMS DescriptionA numeric function over an unknown field — Field '<name>' not found. Available numeric fields: ...
HTTP400 CodeINVALID_PARAMS DescriptionMore than 5 fields passed in groupBy
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not passed
HTTP429 CodeRATE_LIMITED DescriptionRate 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.

Known specifics

count is resolved in one request, numeric functions are not. count is computed in a single call regardless of the size of the result set. The sum, avg, min, max functions load records page by page — up to 5000 — and compute the values on the server side. If more than 5000 records match the filter, meta.truncated is true, and the aggregates and groups are built over the first 5000. The ceiling is not the only reason for this marker: it also appears when fewer records were read than data.count promised, and the size of the gap is reported in data.meta.recordsShortfall.

Fields for grouping and for computation. In groupBy, it makes sense to pass iblockSectionId — the catalog section. The numeric fields purchasingPrice and quantity support sum, avg, min, max.

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.

See also