Outbound calls by time period metrics

GET/v1/reports/outbound/by-time/metrics

Returns outbound-call metrics grouped by the requested time period 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

UTC offset. Defaults to +00:00 when omitted.

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

periodstring required

Example:day

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

groupstring required

namestring required

receivedinteger required

answeredinteger required

unansweredinteger•Outbound unanswered call count. required

loginsinteger required

logoffinteger required

avg_waitnumber (float) required

avg_talknumber (float) required

max_callersinteger required

answered_percentagenumber (float) required

unanswered_percentagenumber (float) required

slanumber (float) 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/outbound/by-time/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&period=day" \
  --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": [
    {
      "group": "string",
      "name": "string",
      "received": 0,
      "answered": 0,
      "unanswered": 0,
      "logins": 0,
      "logoff": 0,
      "avg_wait": 0,
      "avg_talk": 0,
      "max_callers": 0,
      "answered_percentage": 0,
      "unanswered_percentage": 0,
      "sla": 0
    }
  ],
  "meta": {}
}