Zoom Public API Documentation
List historical queue's agents reports
GET {{baseUrl}}/contact_center/analytics/historical/queues/:queueId/agents/metrics?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&channel_types=chat&channel_types=video&interval=1_week
Generate a list of a historical queue's agents reports. Scopes: Rate Limit Label: contact_center_report:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size
|
number | The number of items returned per page. | |
timezone
|
string | The call's timezone. The default is **UTC**. | |
from
|
string | The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, return data from the past 24 hours. | |
to
|
string | **Required** only when the `from` parameters is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter. | |
channel_types
|
string | (Required) The channel's type. Provide only a single channel type. | |
channel_types
|
string | (Required) The channel's type. Provide only a single channel type. | |
interval
|
string | The historical queue report's interval. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 10,
"total_records": "<integer>",
"timezone": "<string>",
"from": "<dateTime>",
"to": "<dateTime>",
"agents": [
{
"user_id": "<string>",
"display_name": "<string>",
"total_inbound": "<long>",
"total_completed": "<long>",
"total_transferred_in": "<long>",
"total_transferred_out": "<long>",
"voice": {
"upgraded_to_video_call": "<long>",
"total_declined": "<long>",
"total_missed": "<long>",
"inbound_average_talking_duration": "<double>",
"inbound_longest_talking_duration": "<double>",
"inbound_shortest_talking_duration": "<double>",
"inbound_average_wrap_up_duration": "<double>",
"inbound_longest_wrap_up_duration": "<double>",
"inbound_shortest_wrap_up_duration": "<double>",
"total_outbound": "<long>",
"hangup_outbound": "<long>",
"short_outbound": "<long>",
"long_outbound": "<long>",
"start_time_interval": "<string>",
"end_time_interval": "<string>",
"total_answered_users": "<long>",
"total_answer_duration": "<double>",
"total_hold_duration": "<double>",
"total_wrap_up_duration": "<double>",
"total_queue_wait_duration": "<double>",
"total_abandoned_duration": "<double>"
},
"video": {
"total_declined": "<long>",
"total_missed": "<long>",
"average_talking_duration": "<double>",
"longest_talking_duration": "<double>",
"shortest_talking_duration": "<double>",
"average_wrap_up_duration": "<double>",
"longest_wrap_up_duration": "<double>",
"shortest_wrap_up_duration": "<double>"
},
"chat": {
"total_sent": "<long>",
"average_sent": "<double>",
"total_abandoned": "<long>",
"total_auto_closed": "<long>",
"total_released": "<long>",
"total_overflowed": "<long>",
"upgraded_to_voice_call": "<long>",
"upgraded_to_video_call": "<long>",
"average_messaging_duration": "<double>",
"longest_messaging_duration": "<double>",
"shortest_messaging_duration": "<double>",
"average_waiting_duration": "<double>",
"shortest_waiting_duration": "<double>",
"longest_waiting_duration": "<double>",
"average_agent_first_message_speed": "<double>",
"shortest_agent_first_message_speed": "<double>",
"longest_agent_first_message_speed": "<double>"
},
"sms": {
"total_sent": "<long>",
"average_sent": "<double>",
"total_abandoned": "<long>",
"total_auto_closed": "<long>",
"total_released": "<long>",
"total_overflowed": "<long>",
"upgraded_to_voice_call": "<long>",
"upgraded_to_video_call": "<long>",
"inbound_average_messaging_duration": "<double>",
"inbound_longest_messaging_duration": "<double>",
"inbound_shortest_messaging_duration": "<double>",
"inbound_average_waiting_duration": "<double>",
"inbound_shortest_waiting_duration": "<double>",
"inbound_longest_waiting_duration": "<double>",
"average_agent_first_message_speed": "<double>",
"shortest_agent_first_message_speed": "<double>",
"longest_agent_first_message_speed": "<double>",
"total_outbound": "<long>"
}
},
{
"user_id": "<string>",
"display_name": "<string>",
"total_inbound": "<long>",
"total_completed": "<long>",
"total_transferred_in": "<long>",
"total_transferred_out": "<long>",
"voice": {
"upgraded_to_video_call": "<long>",
"total_declined": "<long>",
"total_missed": "<long>",
"inbound_average_talking_duration": "<double>",
"inbound_longest_talking_duration": "<double>",
"inbound_shortest_talking_duration": "<double>",
"inbound_average_wrap_up_duration": "<double>",
"inbound_longest_wrap_up_duration": "<double>",
"inbound_shortest_wrap_up_duration": "<double>",
"total_outbound": "<long>",
"hangup_outbound": "<long>",
"short_outbound": "<long>",
"long_outbound": "<long>",
"start_time_interval": "<string>",
"end_time_interval": "<string>",
"total_answered_users": "<long>",
"total_answer_duration": "<double>",
"total_hold_duration": "<double>",
"total_wrap_up_duration": "<double>",
"total_queue_wait_duration": "<double>",
"total_abandoned_duration": "<double>"
},
"video": {
"total_declined": "<long>",
"total_missed": "<long>",
"average_talking_duration": "<double>",
"longest_talking_duration": "<double>",
"shortest_talking_duration": "<double>",
"average_wrap_up_duration": "<double>",
"longest_wrap_up_duration": "<double>",
"shortest_wrap_up_duration": "<double>"
},
"chat": {
"total_sent": "<long>",
"average_sent": "<double>",
"total_abandoned": "<long>",
"total_auto_closed": "<long>",
"total_released": "<long>",
"total_overflowed": "<long>",
"upgraded_to_voice_call": "<long>",
"upgraded_to_video_call": "<long>",
"average_messaging_duration": "<double>",
"longest_messaging_duration": "<double>",
"shortest_messaging_duration": "<double>",
"average_waiting_duration": "<double>",
"shortest_waiting_duration": "<double>",
"longest_waiting_duration": "<double>",
"average_agent_first_message_speed": "<double>",
"shortest_agent_first_message_speed": "<double>",
"longest_agent_first_message_speed": "<double>"
},
"sms": {
"total_sent": "<long>",
"average_sent": "<double>",
"total_abandoned": "<long>",
"total_auto_closed": "<long>",
"total_released": "<long>",
"total_overflowed": "<long>",
"upgraded_to_voice_call": "<long>",
"upgraded_to_video_call": "<long>",
"inbound_average_messaging_duration": "<double>",
"inbound_longest_messaging_duration": "<double>",
"inbound_shortest_messaging_duration": "<double>",
"inbound_average_waiting_duration": "<double>",
"inbound_shortest_waiting_duration": "<double>",
"inbound_longest_waiting_duration": "<double>",
"average_agent_first_message_speed": "<double>",
"shortest_agent_first_message_speed": "<double>",
"longest_agent_first_message_speed": "<double>",
"total_outbound": "<long>"
}
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/analytics/historical/queues/:queueId/agents/metrics?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&channel_types=chat&channel_types=video&interval=1_week?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&channel_types=chat&channel_types=video&interval=1_week' -H 'Accept: application/json'
ENDPOINTS