Skip to navigation

Get concurrent calls

Returns the highest number of calls that were active at the same time in each hour of one day (hourly_peaks, always 24 items), with the limit of the plan. The day is today by default and can be any day from 13 months ago to today, in the timezone. With period it also returns history for that period: the peak, a series of intervals, the seconds spent at the limit, the calls rejected because every line was busy and a heatmap by weekday and hour. agent_id restricts the history to one agent, and from and to are only valid with period=custom. A limit of 0 means the plan has no limit. Required scope: usage: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

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

The day to read, YYYY-MM-DD, in the timezone. Default: today. From 13 months ago to today.

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.

periodenumOptional

Adds history to the response for this period, in the timezone; date still applies only to hourly_peaks. Same values as period of GET /calls: today, 7d, 30d, last_month, 6m, 12m, custom. custom needs from and 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.

agent_idstringOptionalformat: "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,127}$"

Restricts history to one agent of the organization. It needs period.

Response

Successful response.
object"concurrency"

Always concurrency.

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

The day hourly_peaks refers to, in the timezone.

timezonestring
The time zone the day and its hours are in.
limitinteger>=0

Maximum number of simultaneous calls allowed by the plan; 0 when the plan has no limit.

unlimitedboolean

true when the plan has no limit (limit is 0).

hourly_peakslist of objects
The highest number of simultaneous calls in each local hour of the day.
historyobjectOptional

Present only when period is given. Data is refreshed every 5 minutes.

Errors

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