Today workspace summary metrics

GET/v1/reports/summary/calls

Returns aggregated workspace call summary metrics for the current day. When queue is omitted, the response includes all inbound and outbound queues available to the workspace.

Query Parameters

queuearray

Optional comma-separated queues. Omit to aggregate all workspace queues.

Example:1001,1002

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataobject (CallCenterSummaryCallsData) required

total_callsinteger required

inboundinteger required

outboundinteger required

answeredinteger required

unansweredinteger required

abandonedinteger required

transferredinteger•Count of transferred calls for the current day. required

unanswered_outboundinteger required

avg_break_timenumber required

avg_talk_timenumber required

avg_ring_timenumber required

metaobject

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request GET \
  --url "https://api-stg.bevatelcloud.com/v1/reports/summary/calls?queue=1001,1002" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": {
    "total_calls": 0,
    "inbound": 0,
    "outbound": 0,
    "answered": 0,
    "unanswered": 0,
    "abandoned": 0,
    "transferred": 0,
    "unanswered_outbound": 0,
    "avg_break_time": 0,
    "avg_talk_time": 0,
    "avg_ring_time": 0
  },
  "meta": {}
}