reports_series
Retrieve time-series call counts aggregated by dimension across sub-accounts to analyze call volume patterns and trends.
Instructions
Get time-series call data aggregated by dimension across sub-accounts.
Uses the CTM Reports Series API to return call counts broken down by the requested dimension. This is the most flexible reporting endpoint — supports 40+ dimensions for slicing call data.
Required: start_date, end_date (ISO format, e.g. 2026-01-01) by: dimension to aggregate on (use reports_series_dimensions for the full list) interval: time granularity — hour, day (default), month, year
If the response comes back empty (items=0), the output includes the envelope keys so the request can be debugged without checking server logs.
Known limitation: this endpoint occasionally returns items=0 even for accounts with known call volume. When it works it's server-side fast; when it doesn't, fall back to call_disposition_report for the same data (client-side aggregation, works reliably).
Optional filters: direction: inbound, outbound, form, msg_inbound, msg_outbound multi_tracking_numbers + operator: filter by tracking number IDs multi_receiving_numbers + operator: filter by receiving number IDs ring_time/talk_time/duration + operator: filter by time thresholds multi_tags + operator: filter by tag names Operators: includes, excludes, less_than, less_than_equal, greater_than, greater_than_equal, equal
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| by | No | source | |
| duration | No | ||
| end_date | No | ||
| interval | No | day | |
| direction | No | ||
| ring_time | No | ||
| talk_time | No | ||
| multi_tags | No | ||
| start_date | No | ||
| account_ids | No | ||
| account_status | No | ||
| duration_operator | No | ||
| ring_time_operator | No | ||
| talk_time_operator | No | ||
| multi_tags_operator | No | includes | |
| multi_tracking_numbers | No | ||
| multi_receiving_numbers | No | ||
| multi_tracking_numbers_operator | No | includes | |
| multi_receiving_numbers_operator | No | includes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |