> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getvoxai.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getvoxai.com/_mcp/server.

# Get calls summary

GET https://api.getvoxai.com/v1/calls/summary

Returns the totals of the calls of a period and of the period just before it, for comparison: answered and missed calls (with the reason), outcomes, channels, talk time, report cards, sentiment and transfers to a person. The figures are the same as in the summary of the app. Durations are talk time, not billed minutes: for those use `GET /usage`. Required scope: `calls:read`. With a test key (`vx_test_`) it behaves exactly as with a live key and consumes nothing.

Reference: https://docs.getvoxai.com/api-reference/calls/summary

## Authentication

- `Authorization` header (bearer token, required) — API key created by an Owner or Admin of the organization. Never in the query string.

## Request

### Query parameters

- `period` (enum, optional) — The period to read, in the `timezone`. Default `7d`. `today`: from midnight to now. `7d`, `30d`: the last 7 or 30 days, today included. `last_month`: the previous calendar month. `6m`, `12m`: the last 6 or 12 months. `custom`: from `from` to `to`, at most 13 months.
  - Allowed values: `today`, `7d`, `30d`, `last_month`, `6m`, `12m`, `custom`
- `from` (string, optional) — First day of a `custom` period, YYYY-MM-DD, in the `timezone`. Only with `period=custom`.
- `to` (string, optional) — Last day of a `custom` period, YYYY-MM-DD, included. Only with `period=custom`.
- `timezone` (string, optional) — IANA time zone the period is computed in, for example `Europe/Rome` (default). It decides where days start and end.

### Headers

- `VoxAI-Version` (enum, optional) — API version for this request; defaults to the version the key is pinned to.
  - Allowed values: `2026-10-01`

## Response

### 200

Successful response.

- `object` ("call_summary", required) — Always `call_summary`.
- `period` (CallsSummaryGetResponsesContentApplicationJsonSchemaPeriod, required) — The period of `current`.
- `previous_period` (CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousPeriod, required) — The period of the same length just before, used for `previous`.
- `current` (CallsSummaryGetResponsesContentApplicationJsonSchemaCurrent, required) — The figures of the period.
- `previous` (CallsSummaryGetResponsesContentApplicationJsonSchemaPrevious, required) — The same figures for the previous period, to compute the change.

## Errors

### 400 Bad Request Error

Possible errors: * `invalid_api_version`: The `VoxAI-Version` header names a version that does not exist. Use one of the versions listed in the `VoxAI-Version` parameter, or omit the header to use the version the key is pinned to. * `invalid_period`: The period is not valid: `from` or `to` with a named period, `custom` without both, a day that does not exist, or `from` after `to`. Use a named `period`, or `period=custom` with `from` and `to` (YYYY-MM-DD, `to` included). * `invalid_request`: The path, query or body does not match the schema of the operation: a missing or unknown field, a wrong type, a value out of range. Fix the request. `details` lists each problem as `{ location, path, message }`: `location` is `params`, `query` or `body` and `path` points to the field. * `invalid_timezone`: The `timezone` is not a known IANA time zone. Use a name such as `Europe/Rome`, or omit it (default `Europe/Rome`). * `period_too_long`: The `custom` period is longer than 13 months. Split the range into shorter periods.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 401 Unauthorized Error

Possible errors: - `invalid_api_key`: The `Authorization` header is missing, malformed, or carries a key that does not exist, was revoked or has expired. Send `Authorization: Bearer vx_live_…` (or `vx_test_…`) with an active key. Create a new key in the app if this one expired.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 403 Forbidden Error

Possible errors: - `feature_not_available`: The plan of the organization does not include the API, or the feature this operation needs. Upgrade the plan in the app. Reads and deletions stay available after a downgrade. - `insufficient_scope`: The key does not have the scope this operation requires (written in the description of the operation). Create a key with the required scope (an Owner or Admin can do it in the app), or ask for the scope to be added. - `ip_not_allowed`: The key has an IP allow-list and the request comes from an address that is not on it. Call from an allowed address, or add this address to the key in the app. - `organization_suspended`: The organization that owns the key is suspended. Contact the organization Owner: nothing can be done through the API until the organization is active again.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 429 Too Many Requests Error

Possible errors: - `rate_limited`: Too many requests: over the per-minute limit of this key or of the whole organization (see `rate_limits` in `GET /me`), or over a limit of the operation itself, such as the hourly limit on webhook tests and resends. Wait for the number of seconds in the `Retry-After` header, then retry. Spread requests over time.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 500 Internal Server Error

Possible errors: - `internal_error`: An unexpected error on our side. Retry once after a few seconds. For writes marked as retriable, retry with the same `Idempotency-Key`, so the operation is never done twice; for the other writes, first read the state of the resource, then retry with a NEW key only if the operation did not happen. If it persists, contact support with the `requestId`.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 503 Service Unavailable Error

Possible errors: - `api_not_configured`: The API is not enabled on this service. Contact support.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

## Types

### CallsSummaryGetResponsesContentApplicationJsonSchemaPeriod

The period of `current`.

- `preset` (enum, required) — The named period used, as in the `period` parameter (`7d` when none was asked): `today`, `7d`, `30d`, `last_month`, `6m`, `12m`, `custom`.
  - Allowed values: `today`, `7d`, `30d`, `last_month`, `6m`, `12m`, `custom`
- `from` (datetime, required) — Start of the period, ISO 8601 UTC, included.
- `to` (datetime, required) — End of the period, ISO 8601 UTC, excluded.
- `timezone` (string, required) — The time zone the period was computed in.

### CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousPeriod

The period of the same length just before, used for `previous`.

- `from` (datetime, required) — Start, ISO 8601 UTC, included.
- `to` (datetime, required) — End, ISO 8601 UTC, excluded.

### CallsSummaryGetResponsesContentApplicationJsonSchemaCurrent

The figures of the period.

- `total` (integer, required) — Calls started in the period, answered or missed.
- `answered` (integer, required) — Calls answered by an agent.
- `missed` (CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentMissed, required) — Calls rejected before an agent answered, by reason.
- `outcomes` (CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentOutcomes, required) — Answered calls by how they ended.
- `channels` (CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentChannels, required) — Calls by channel.
- `duration` (CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentDuration, required) — Talk time of the period.
- `report_cards` (CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentReportCards, required) — Report cards of the period.
- `sentiment` (CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentSentiment, required) — Mood of the caller, as judged in the report card.
- `transfers` (CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentTransfers, required) — Transfers to a person.
- `concluded_without_transfer` (integer, required) — Calls concluded by the agent alone, without a transfer to a person.

### CallsSummaryGetResponsesContentApplicationJsonSchemaPrevious

The same figures for the previous period, to compute the change.

- `total` (integer, required) — Calls started in the period, answered or missed.
- `answered` (integer, required) — Calls answered by an agent.
- `missed` (CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousMissed, required) — Calls rejected before an agent answered, by reason.
- `outcomes` (CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousOutcomes, required) — Answered calls by how they ended.
- `channels` (CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousChannels, required) — Calls by channel.
- `duration` (CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousDuration, required) — Talk time of the period.
- `report_cards` (CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousReportCards, required) — Report cards of the period.
- `sentiment` (CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousSentiment, required) — Mood of the caller, as judged in the report card.
- `transfers` (CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousTransfers, required) — Transfers to a person.
- `concluded_without_transfer` (integer, required) — Calls concluded by the agent alone, without a transfer to a person.

### CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentMissed

Calls rejected before an agent answered, by reason.

- `total` (integer, required) — All the calls rejected before an agent answered.
- `lines_busy` (integer, required) — Rejected because all the concurrent-call lines were busy.
- `quota_exhausted` (integer, required) — Rejected because the plan minutes were used up.
- `suspended` (integer, required) — Rejected because the organization was suspended.
- `platform` (integer, required) — Rejected because the service was at capacity.
- `agent_suspended` (integer, required) — Rejected because the agent was suspended by the organization.

### CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentOutcomes

Answered calls by how they ended.

- `completed` (integer, required) — Calls that ended normally (transfers to a person included).
- `interrupted` (integer, required) — Calls cut before their natural end.
- `failed` (integer, required) — Calls that could not take place because of an error.
- `in_progress` (integer, required) — Calls still going on.
- `forwarded` (integer, required) — Inbound calls forwarded without the agent: to the business number, because the answering mode is `outside_hours_only` and the business was open, or to the verified backup number, because the minutes were used up. Also counted in `total` and `answered`.

### CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentChannels

Calls by channel.

- `phone_inbound` (integer, required) — Phone calls received.
- `phone_outbound` (integer, required) — Phone calls made by an agent.
- `web` (integer, required) — Conversations in the web widget.

### CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentDuration

Talk time of the period.

- `total_seconds` (integer, required) — Total talk time in seconds.
- `average_seconds` (integer, required, nullable) — Average talk time per call with a duration, in seconds; `null` when no call has a duration.
- `total_minutes` (double, required) — Total talk time in minutes, one decimal. Talk time, not billed minutes (see `GET /usage`).

### CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentReportCards

Report cards of the period.

- `evaluated` (integer, required) — Calls with a ready report card.
- `goal_achieved` (integer, required) — Evaluated calls where the agent reached its goal.
- `negative` (integer, required) — Evaluated calls with a negative outcome.
- `pending` (integer, required) — Calls that ended a few minutes ago and whose report card is still being computed. Always 0 for the previous period.

### CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentSentiment

Mood of the caller, as judged in the report card.

- `positive` (integer, required) — Calls where the caller sounded satisfied.
- `neutral` (integer, required) — Calls with a neutral tone.
- `negative` (integer, required) — Calls where the caller sounded unhappy.

### CallsSummaryGetResponsesContentApplicationJsonSchemaCurrentTransfers

Transfers to a person.

- `attempted` (integer, required) — Transfers to a person the agent tried.
- `answered` (integer, required) — Transfers a person answered.

### CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousMissed

Calls rejected before an agent answered, by reason.

- `total` (integer, required) — All the calls rejected before an agent answered.
- `lines_busy` (integer, required) — Rejected because all the concurrent-call lines were busy.
- `quota_exhausted` (integer, required) — Rejected because the plan minutes were used up.
- `suspended` (integer, required) — Rejected because the organization was suspended.
- `platform` (integer, required) — Rejected because the service was at capacity.
- `agent_suspended` (integer, required) — Rejected because the agent was suspended by the organization.

### CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousOutcomes

Answered calls by how they ended.

- `completed` (integer, required) — Calls that ended normally (transfers to a person included).
- `interrupted` (integer, required) — Calls cut before their natural end.
- `failed` (integer, required) — Calls that could not take place because of an error.
- `in_progress` (integer, required) — Calls still going on.
- `forwarded` (integer, required) — Inbound calls forwarded without the agent: to the business number, because the answering mode is `outside_hours_only` and the business was open, or to the verified backup number, because the minutes were used up. Also counted in `total` and `answered`.

### CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousChannels

Calls by channel.

- `phone_inbound` (integer, required) — Phone calls received.
- `phone_outbound` (integer, required) — Phone calls made by an agent.
- `web` (integer, required) — Conversations in the web widget.

### CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousDuration

Talk time of the period.

- `total_seconds` (integer, required) — Total talk time in seconds.
- `average_seconds` (integer, required, nullable) — Average talk time per call with a duration, in seconds; `null` when no call has a duration.
- `total_minutes` (double, required) — Total talk time in minutes, one decimal. Talk time, not billed minutes (see `GET /usage`).

### CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousReportCards

Report cards of the period.

- `evaluated` (integer, required) — Calls with a ready report card.
- `goal_achieved` (integer, required) — Evaluated calls where the agent reached its goal.
- `negative` (integer, required) — Evaluated calls with a negative outcome.
- `pending` (integer, required) — Calls that ended a few minutes ago and whose report card is still being computed. Always 0 for the previous period.

### CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousSentiment

Mood of the caller, as judged in the report card.

- `positive` (integer, required) — Calls where the caller sounded satisfied.
- `neutral` (integer, required) — Calls with a neutral tone.
- `negative` (integer, required) — Calls where the caller sounded unhappy.

### CallsSummaryGetResponsesContentApplicationJsonSchemaPreviousTransfers

Transfers to a person.

- `attempted` (integer, required) — Transfers to a person the agent tried.
- `answered` (integer, required) — Transfers a person answered.

## Examples

**Response**

```json
{
  "object": "call_summary",
  "period": {
    "preset": "7d",
    "from": "2026-11-09T23:00:00Z",
    "to": "2026-11-16T23:00:00Z",
    "timezone": "Europe/Rome"
  },
  "previous_period": {
    "from": "2026-11-02T23:00:00Z",
    "to": "2026-11-09T23:00:00Z"
  },
  "current": {
    "total": 128,
    "answered": 121,
    "missed": {
      "total": 7,
      "lines_busy": 5,
      "quota_exhausted": 0,
      "suspended": 0,
      "platform": 0,
      "agent_suspended": 2
    },
    "outcomes": {
      "completed": 104,
      "interrupted": 9,
      "failed": 3,
      "in_progress": 1,
      "forwarded": 4
    },
    "channels": {
      "phone_inbound": 96,
      "phone_outbound": 24,
      "web": 8
    },
    "duration": {
      "total_seconds": 21780,
      "average_seconds": 180,
      "total_minutes": 363
    },
    "report_cards": {
      "evaluated": 117,
      "goal_achieved": 98,
      "negative": 6,
      "pending": 2
    },
    "sentiment": {
      "positive": 71,
      "neutral": 40,
      "negative": 6
    },
    "transfers": {
      "attempted": 14,
      "answered": 12
    },
    "concluded_without_transfer": 92
  },
  "previous": {
    "total": 112,
    "answered": 108,
    "missed": {
      "total": 4,
      "lines_busy": 4,
      "quota_exhausted": 0,
      "suspended": 0,
      "platform": 0,
      "agent_suspended": 0
    },
    "outcomes": {
      "completed": 95,
      "interrupted": 7,
      "failed": 2,
      "in_progress": 0,
      "forwarded": 4
    },
    "channels": {
      "phone_inbound": 88,
      "phone_outbound": 18,
      "web": 6
    },
    "duration": {
      "total_seconds": 19044,
      "average_seconds": 176,
      "total_minutes": 317.4
    },
    "report_cards": {
      "evaluated": 106,
      "goal_achieved": 87,
      "negative": 7,
      "pending": 0
    },
    "sentiment": {
      "positive": 60,
      "neutral": 39,
      "negative": 7
    },
    "transfers": {
      "attempted": 11,
      "answered": 10
    },
    "concluded_without_transfer": 84
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.getvoxai.com/v1/calls/summary"

querystring = {"period":"7d","timezone":"Europe/Rome"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.getvoxai.com/v1/calls/summary?period=7d&timezone=Europe%2FRome';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getvoxai.com/v1/calls/summary?period=7d&timezone=Europe%2FRome"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.getvoxai.com/v1/calls/summary?period=7d&timezone=Europe%2FRome")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.getvoxai.com/v1/calls/summary?period=7d&timezone=Europe%2FRome")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.getvoxai.com/v1/calls/summary?period=7d&timezone=Europe%2FRome', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.getvoxai.com/v1/calls/summary?period=7d&timezone=Europe%2FRome");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getvoxai.com/v1/calls/summary?period=7d&timezone=Europe%2FRome")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```