Skip to navigation

Get 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.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Query parameters

periodenumOptional

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.

fromstringOptionalformat: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"

First day of a custom period, YYYY-MM-DD, in the timezone. Only with period=custom.

tostringOptionalformat: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"

Last day of a custom period, YYYY-MM-DD, included. Only with period=custom.

timezonestringOptionalformat: "^[A-Za-z0-9_+/-]+$"1-64 characters

IANA time zone the period is computed in, for example Europe/Rome (default). It decides where days start and end.

Response

Successful response.
object"call_summary"

Always call_summary.

periodobject

The period of current.

previous_periodobject

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

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

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error