---
title: "Calls by destination report"
method: GET
path: "/call_records/destinations"
tags: ["Calls"]
---

# Calls by destination report

`GET /call_records/destinations`

## Request

- Base URL: `https://api.commpeak.com/portal`
- URL: `https://api.commpeak.com/portal/call_records/destinations`
- Auth: API key in header `Authorization`

Returns outbound call totals per destination network for a date range, as the Calls by Destination report in the portal: number of calls, successful (billable) calls, total duration in seconds, total cost, ASR (percent) and ACD (seconds), plus `totals` for the whole range. Data is aggregated per calendar day (UTC); without `time_range` the last week is returned and a range can span at most 1 year. Results can be narrowed by SIP account, country (ISO 3166-1 alpha-2 code) and network type, and split per SIP account with `group_by_sip_account`.

## Query parameters

- `time_range` string, nullable: Date range "YYYY-MM-DD - YYYY-MM-DD" (or a single date).
- `sip_account_id` string, nullable: Filter by SIP account display_token.
- `country` string, nullable: Filter by destination country, ISO 3166-1 alpha-2 code (e.g. US).
- `network_type` string, nullable: Filter by network type: fixed, mobile, other, premium, sharedcost.
- `group_by_sip_account` boolean, nullable: Split the rows per SIP account.

## Response `200`

Successful Response

- CallsByDestinationResponse: Envelope returned by `GET /portal/call_records/destinations`.
  - `destinations` CallsByDestinationRow[], required: One row per destination network (and SIP account with `group_by_sip_account`).
    - `total_calls` integer, nullable: Number of calls.
    - `successful_calls` integer, nullable: Number of successful (billable) calls.
    - `total_time` integer, nullable: Total duration in seconds.
    - `cost` number, nullable: Total cost.
    - `asr` number, nullable: Answer-Seizure Ratio (percent, 0-100).
    - `acd` number, nullable: Average Call Duration in seconds.
    - `network` string, nullable: Destination network name.
    - `country` string, nullable: Destination country, ISO 3166-1 alpha-2.
    - `network_type` string, nullable: Network type: fixed, mobile, other, premium, sharedcost.
    - `sip_account_id` string, nullable: SIP account display token (only with `group_by_sip_account`).
  - `totals` CallTotals: Outbound call totals, shared by the report rows and their `totals`.
    - `total_calls` integer, nullable: Number of calls.
    - `successful_calls` integer, nullable: Number of successful (billable) calls.
    - `total_time` integer, nullable: Total duration in seconds.
    - `cost` number, nullable: Total cost.
    - `asr` number, nullable: Answer-Seizure Ratio (percent, 0-100).
    - `acd` number, nullable: Average Call Duration in seconds.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/commpeak/apis/commpeak-portal-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-portal-api/revisions/df57b0c16367?raw)