Aggregate the Call Analytics call records into grouped summary rows over a required date range.

When to use. Produce summary rows (totals, durations, ACD, ASR, cost) grouped by one or more dimensions such as campaign, user, or country. For the individual call rows behind Call Analytics rather than aggregates, use GET /cdrs.

Request body. group and filter are required, and filter must include filter.start_at and filter.end_at. See Core API Concepts.

• group (string, required): semicolon-separated dimensions to group by, for example campaign;user;call status;duration;country;timezone.
• fields (string): semicolon-separated columns to include in each row, for example campaign;user;total calls;successful calls;total duration;ACD;ASR;cost.
• period (string): semicolon-separated time buckets. Defaults to year;month;day. Example year;month;day;hour.
• weightSteps (string): weight-step buckets to group by, for example All, 100, 50.
• filter (object, required): filter criteria. start_at and end_at are required and do not accept an operator. Other keys accept a single value, an array, or a value;operator expression, for example "duration": "5;>|9999;<".
• order (string): sort order, for example campaign;desc. The field must appear in group or fields.
• limit (integer): maximum rows to return, 1 to 500, default 500.
• offset (integer): row offset for pagination.

Notes. callsType accepts an array of call-type ids: PHONEBOOK 2, MANUAL_CALL 3, INCOMING 4, PROGRESSIVE 5, PREDICTIVE 6, MISSED_CALL 7, INTERNAL_CALL 8.

Returns. 201 with an array of aggregated rows. Each row carries the grouped dimensions plus the requested metrics (total, successful, call_duration, call_bill_duration, acd, asr, cost, and so on). Durations are formatted as H:MM:SS and period reflects the chosen buckets.

Example.

{
  "group": "campaign;user;country",
  "fields": "campaign;user;total calls;successful calls;ACD;ASR;cost",
  "period": "year;month;day",
  "weightSteps": "All",
  "filter": {
    "start_at": "2020-01-01 00:00:00",
    "end_at": "2025-01-01 00:00:00",
    "campaign": [22],
    "duration": "5;>|9999;<"
  },
  "order": "campaign;desc",
  "limit": 100,
  "offset": 0
}