List historical queue reports
GET {{baseUrl}}/contact_center/analytics/historical/queues/metrics?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queue_ids=<string>&queue_ids=<string>&channel_types=chat&channel_types=video&interval=1_week
Generate a list of historical queue reports.
Scopes: contact_center_report:read:admin
Rate Limit Label: Heavy
Request Params
| 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. | |
queue_ids | string | A comma-separated list of queue IDs to query, up to 20 queue IDs. | |
queue_ids | string | A comma-separated list of queue IDs to query, up to 20 queue IDs. | |
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":"\u003cstring\u003e","page_size":10,"total_records":"\u003cinteger\u003e","timezone":"\u003cstring\u003e","from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e","queues":[{"queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e","total_inbound":"\u003clong\u003e","total_completed":"\u003clong\u003e","total_transferred_in":"\u003clong\u003e","total_transferred_out":"\u003clong\u003e","voice":{"service_level":"\u003cdouble\u003e","short_abandoned":"\u003clong\u003e","long_abandoned":"\u003clong\u003e","hold_abandoned":"\u003clong\u003e","total_missed":"\u003clong\u003e","total_overflowed":"\u003clong\u003e","upgraded_to_video_call":"\u003clong\u003e","inbound_average_waiting_duration":"\u003cdouble\u003e","inbound_shortest_waiting_duration":"\u003cdouble\u003e","inbound_longest_waiting_duration":"\u003cdouble\u003e","inbound_average_talking_duration":"\u003cdouble\u003e","inbound_longest_talking_duration":"\u003cdouble\u003e","inbound_shortest_talking_duration":"\u003cdouble\u003e","inbound_average_wrap_up_duration":"\u003cdouble\u003e","inbound_longest_wrap_up_duration":"\u003cdouble\u003e","inbound_shortest_wrap_up_duration":"\u003cdouble\u003e","total_outbound":"\u003clong\u003e","hangup_outbound":"\u003clong\u003e","short_outbound":"\u003clong\u003e","long_outbound":"\u003clong\u003e","start_time_interval":"\u003cstring\u003e","end_time_interval":"\u003cstring\u003e","total_answered_users":"\u003clong\u003e","total_answer_duration":"\u003cdouble\u003e","total_hold_duration":"\u003cdouble\u003e","total_wrap_up_duration":"\u003cdouble\u003e","total_queue_wait_duration":"\u003cdouble\u003e","total_abandoned_duration":"\u003cdouble\u003e"},"sms":{"start_time_interval":"\u003cstring\u003e","end_time_interval":"\u003cstring\u003e","total_sent":"\u003clong\u003e","average_sent":"\u003cdouble\u003e","total_auto_closed":"\u003clong\u003e","total_released":"\u003clong\u003e","total_abandoned":"\u003clong\u003e","total_overflowed":"\u003clong\u003e","upgraded_to_voice_call":"\u003clong\u003e","upgraded_to_video_call":"\u003clong\u003e","inbound_average_waiting_duration":"\u003cdouble\u003e","inbound_shortest_waiting_duration":"\u003cdouble\u003e","inbound_longest_waiting_duration":"\u003cdouble\u003e","inbound_average_messaging_duration":"\u003cdouble\u003e","inbound_longest_messaging_duration":"\u003cdouble\u003e","inbound_shortest_messaging_duration":"\u003cdouble\u003e","average_agent_first_message_speed":"\u003cdouble\u003e","shortest_agent_first_message_speed":"\u003cdouble\u003e","longest_agent_first_message_speed":"\u003cdouble\u003e","total_outbound":"\u003clong\u003e"},"chat":{"start_time_interval":"\u003cstring\u003e","end_time_interval":"\u003cstring\u003e","service_level":"\u003cdouble\u003e","total_sent":"\u003clong\u003e","average_sent":"\u003cdouble\u003e","total_abandoned":"\u003clong\u003e","total_auto_closed":"\u003clong\u003e","total_released":"\u003clong\u003e","upgraded_to_voice_call":"\u003clong\u003e","upgraded_to_video_call":"\u003clong\u003e","average_waiting_duration":"\u003cdouble\u003e","shortest_waiting_duration":"\u003cdouble\u003e","longest_waiting_duration":"\u003cdouble\u003e","average_messaging_duration":"\u003cdouble\u003e","longest_messaging_duration":"\u003cdouble\u003e","shortest_messaging_duration":"\u003cdouble\u003e","average_agent_first_message_speed":"\u003cdouble\u003e","shortest_agent_first_message_speed":"\u003cdouble\u003e","longest_agent_first_message_speed":"\u003cdouble\u003e"},"video":{"start_time_interval":"\u003cstring\u003e","end_time_interval":"\u003cstring\u003e","service_level":"\u003cdouble\u003e","short_abandoned":"\u003clong\u003e","long_abandoned":"\u003clong\u003e","hold_abandoned":"\u003clong\u003e","total_missed":"\u003clong\u003e","total_overflowed":"\u003clong\u003e","average_waiting_duration":"\u003cdouble\u003e","shortest_waiting_duration":"\u003cdouble\u003e","longest_waiting_duration":"\u003cdouble\u003e","average_talking_duration":"\u003cdouble\u003e","longest_talking_duration":"\u003cdouble\u003e","shortest_talking_duration":"\u003cdouble\u003e","average_wrap_up_duration":"\u003cdouble\u003e","longest_wrap_up_duration":"\u003cdouble\u003e","shortest_wrap_up_duration":"\u003cdouble\u003e"}},{"queue_id":"\u003cstring\u003e","queue_name":"\u003cstring\u003e","total_inbound":"\u003clong\u003e","total_completed":"\u003clong\u003e","total_transferred_in":"\u003clong\u003e","total_transferred_out":"\u003clong\u003e","voice":{"service_level":"\u003cdouble\u003e","short_abandoned":"\u003clong\u003e","long_abandoned":"\u003clong\u003e","hold_abandoned":"\u003clong\u003e","total_missed":"\u003clong\u003e","total_overflowed":"\u003clong\u003e","upgraded_to_video_call":"\u003clong\u003e","inbound_average_waiting_duration":"\u003cdouble\u003e","inbound_shortest_waiting_duration":"\u003cdouble\u003e","inbound_longest_waiting_duration":"\u003cdouble\u003e","inbound_average_talking_duration":"\u003cdouble\u003e","inbound_longest_talking_duration":"\u003cdouble\u003e","inbound_shortest_talking_duration":"\u003cdouble\u003e","inbound_average_wrap_up_duration":"\u003cdouble\u003e","inbound_longest_wrap_up_duration":"\u003cdouble\u003e","inbound_shortest_wrap_up_duration":"\u003cdouble\u003e","total_outbound":"\u003clong\u003e","hangup_outbound":"\u003clong\u003e","short_outbound":"\u003clong\u003e","long_outbound":"\u003clong\u003e","start_time_interval":"\u003cstring\u003e","end_time_interval":"\u003cstring\u003e","total_answered_users":"\u003clong\u003e","total_answer_duration":"\u003cdouble\u003e","total_hold_duration":"\u003cdouble\u003e","total_wrap_up_duration":"\u003cdouble\u003e","total_queue_wait_duration":"\u003cdouble\u003e","total_abandoned_duration":"\u003cdouble\u003e"},"sms":{"start_time_interval":"\u003cstring\u003e","end_time_interval":"\u003cstring\u003e","total_sent":"\u003clong\u003e","average_sent":"\u003cdouble\u003e","total_auto_closed":"\u003clong\u003e","total_released":"\u003clong\u003e","total_abandoned":"\u003clong\u003e","total_overflowed":"\u003clong\u003e","upgraded_to_voice_call":"\u003clong\u003e","upgraded_to_video_call":"\u003clong\u003e","inbound_average_waiting_duration":"\u003cdouble\u003e","inbound_shortest_waiting_duration":"\u003cdouble\u003e","inbound_longest_waiting_duration":"\u003cdouble\u003e","inbound_average_messaging_duration":"\u003cdouble\u003e","inbound_longest_messaging_duration":"\u003cdouble\u003e","inbound_shortest_messaging_duration":"\u003cdouble\u003e","average_agent_first_message_speed":"\u003cdouble\u003e","shortest_agent_first_message_speed":"\u003cdouble\u003e","longest_agent_first_message_speed":"\u003cdouble\u003e","total_outbound":"\u003clong\u003e"},"chat":{"start_time_interval":"\u003cstring\u003e","end_time_interval":"\u003cstring\u003e","service_level":"\u003cdouble\u003e","total_sent":"\u003clong\u003e","average_sent":"\u003cdouble\u003e","total_abandoned":"\u003clong\u003e","total_auto_closed":"\u003clong\u003e","total_released":"\u003clong\u003e","upgraded_to_voice_call":"\u003clong\u003e","upgraded_to_video_call":"\u003clong\u003e","average_waiting_duration":"\u003cdouble\u003e","shortest_waiting_duration":"\u003cdouble\u003e","longest_waiting_duration":"\u003cdouble\u003e","average_messaging_duration":"\u003cdouble\u003e","longest_messaging_duration":"\u003cdouble\u003e","shortest_messaging_duration":"\u003cdouble\u003e","average_agent_first_message_speed":"\u003cdouble\u003e","shortest_agent_first_message_speed":"\u003cdouble\u003e","longest_agent_first_message_speed":"\u003cdouble\u003e"},"video":{"start_time_interval":"\u003cstring\u003e","end_time_interval":"\u003cstring\u003e","service_level":"\u003cdouble\u003e","short_abandoned":"\u003clong\u003e","long_abandoned":"\u003clong\u003e","hold_abandoned":"\u003clong\u003e","total_missed":"\u003clong\u003e","total_overflowed":"\u003clong\u003e","average_waiting_duration":"\u003cdouble\u003e","shortest_waiting_duration":"\u003cdouble\u003e","longest_waiting_duration":"\u003cdouble\u003e","average_talking_duration":"\u003cdouble\u003e","longest_talking_duration":"\u003cdouble\u003e","shortest_talking_duration":"\u003cdouble\u003e","average_wrap_up_duration":"\u003cdouble\u003e","longest_wrap_up_duration":"\u003cdouble\u003e","shortest_wrap_up_duration":"\u003cdouble\u003e"}}]}