Agent pause metrics

GET/v1/reports/agents/pauses/metrics

Returns per-agent pause metrics for the selected date/time window, queues, and agents.

Query Parameters

from_datestring required

Start date (DD-MM-YYYY).

Example:06-05-2026

to_datestring required

End date (DD-MM-YYYY).

Example:17-05-2026

from_timestring

Start time (HH-MM-SS). Defaults to start of day.

Example:00-00-00

to_timestring

End time (HH-MM-SS). Defaults to end of day.

Example:23-59-59

time_zonestring required

Required UTC offset.

Example:+03:00

queuearray

Optional comma-separated queue numbers or names. Omit to include all workspace queues.

Example:1001,1002

agentarray

Optional comma-separated agent identifiers (extension number or name). Omit to include all workspace agents.

Example:2001,2002

Responses

Body

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

Example:200

messagestring required

Example:OK

detailsobject required

dataarray[object] required

agentstring required

dndinteger required

dnd_durationinteger required

meetinginteger required

meeting_durationinteger required

breakinteger required

break_durationinteger required

wrap_upinteger required

wrap_up_durationinteger required

otherinteger required

other_durationinteger required

totalinteger required

total_durationinteger 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/agents/pauses/metrics?from_date=06-05-2026&to_date=17-05-2026&from_time=00-00-00&to_time=23-59-59&time_zone=+03:00&queue=1001,1002&agent=2001,2002" \
  --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

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": [
    {
      "agent": "string",
      "dnd": 0,
      "dnd_duration": 0,
      "meeting": 0,
      "meeting_duration": 0,
      "break": 0,
      "break_duration": 0,
      "wrap_up": 0,
      "wrap_up_duration": 0,
      "other": 0,
      "other_duration": 0,
      "total": 0,
      "total_duration": 0
    }
  ],
  "meta": {}
}