Today per-agent summary metrics

GET/v1/reports/summary/agents

Returns paginated per-agent call summary metrics for the current day, including inbound, outbound, unanswered, and break-time values.

Query Parameters

pageinteger

Example:1

per_pageinteger

Example:25

Responses

Body

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

Example:200

messagestring required

Example:OK

detailsobject required

dataobject (CallCenterSummaryAgentsData) required

agents_countinteger•Total agents matching filters (across all pages). required

agentsarray[object] required

agent_namestring required

agent_numberstring or null

inboundinteger required

outboundinteger required

answeredinteger required

unansweredinteger required

unanswered_outboundinteger required

transferredinteger required

abandonedinteger required

avg_break_timenumber required

avg_talk_timenumber required

avg_ring_timenumber required

metaobject (CallCenterPaginationMeta) required

current_pageinteger required

per_pageinteger required

totalinteger required

last_pageinteger required

linksobject required

firststring required

laststring required

prevstring or null required

nextstring or null 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

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/agents?page=1&per_page=25" \
  --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
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": {
    "agents_count": 0,
    "agents": [
      {
        "agent_name": "string",
        "agent_number": "string",
        "inbound": 0,
        "outbound": 0,
        "answered": 0,
        "unanswered": 0,
        "unanswered_outbound": 0,
        "transferred": 0,
        "abandoned": 0,
        "avg_break_time": 0,
        "avg_talk_time": 0,
        "avg_ring_time": 0
      }
    ]
  },
  "meta": {
    "current_page": 0,
    "per_page": 0,
    "total": 0,
    "last_page": 0,
    "links": {
      "first": "string",
      "last": "string",
      "prev": "string",
      "next": "string"
    }
  }
}