Zoom Public API Documentation
List historical detail reports
GET {{baseUrl}}/contact_center/analytics/historical/details/metrics?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queue_ids=<string>&queue_ids=<string>&user_id=<string>&consumer_number=<string>&consumer_id=<string>&direction=outbound&results=<string>&results=<string>&channel_types=chat&channel_types=video&queue_wait_type=live_waiting&required_skill_ids=<string>&required_skill_ids=<string>
Generate a list of historical detail 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. | |
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. | |
user_id
|
string | The agent's ID. | |
consumer_number
|
string | The consumer's phone number. | |
consumer_id
|
string | The consumer ID for video, chat, or SMS engagements. | |
direction
|
string | The engagement's direction. Voice, SMS: * `inbound` * `outbound` Chat, Video: * `inbound` | |
results
|
string | The engagement's results. Voice: * `completed` * `short_abandoned` * `long_abandoned` * `hold_abandoned` * `overflowed_to_inbox` * `overflowed_to_disconnect` * `long_calls` * `short_calls` * `hang_up_calls` * `missed` * `declined` Video: * `completed` * `short_abandoned` * `long_abandoned` * `missed` * `declined` Chat, SMS: * `completed` * `auto_closed` * `missed` * `declined` | |
results
|
string | The engagement's results. Voice: * `completed` * `short_abandoned` * `long_abandoned` * `hold_abandoned` * `overflowed_to_inbox` * `overflowed_to_disconnect` * `long_calls` * `short_calls` * `hang_up_calls` * `missed` * `declined` Video: * `completed` * `short_abandoned` * `long_abandoned` * `missed` * `declined` Chat, SMS: * `completed` * `auto_closed` * `missed` * `declined` | |
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. | |
queue_wait_type
|
string | The queue's wait type. This is applicable to voice channel. | |
required_skill_ids
|
string | The required skill's ID. This is applicable to voice channel. | |
required_skill_ids
|
string | The required skill's ID. This is applicable to voice channel. |
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>",
"details": [
{
"engagement_id": "<string>",
"direction": "outbound",
"consumer_number": "<string>",
"consumer_id": "<string>",
"consumer_name": "<string>",
"start_time": "<dateTime>",
"results": "hold_abandoned",
"total_duration": "<long>",
"ivr_duration": "<long>",
"waiting_duration": "<long>",
"talking_duration": "<long>",
"hold_duration": "<long>",
"wrap_up_duration": "<long>",
"disposition_id": "<string>",
"disposition_name": "<string>",
"flows": [
{
"flow_id": "<string>",
"flow_name": "<string>",
"flow_version": "<string>"
},
{
"flow_id": "<string>",
"flow_name": "<string>",
"flow_version": "<string>"
}
],
"queues": [
{
"queue_id": "<string>",
"queue_name": "<string>"
},
{
"queue_id": "<string>",
"queue_name": "<string>"
}
],
"agents": [
{
"user_id": "<string>",
"display_name": "<string>"
},
{
"user_id": "<string>",
"display_name": "<string>"
}
],
"total_flow_duration": "<long>",
"queue_wait_type": "live_waiting",
"last_widget_name": "<string>",
"agent_first_message_speed": "<long>",
"dialed_numbers": [
"<string>",
"<string>"
],
"callback_waiting_duration": "<long>",
"callback_pending_duration": "<long>",
"handling_duration": "<long>",
"ring_duration": "<long>",
"required_skills": [
{
"skill_id": "<string>",
"skill_name": "<string>",
"minimum_proficiency_level": "<integer>"
},
{
"skill_id": "<string>",
"skill_name": "<string>",
"minimum_proficiency_level": "<integer>"
}
],
"optional_skills": [
{
"skill_id": "<string>",
"skill_name": "<string>",
"matched": "<boolean>"
},
{
"skill_id": "<string>",
"skill_name": "<string>",
"matched": "<boolean>"
}
],
"agent_skills": [
{
"skill_id": "<string>",
"skill_name": "<string>",
"proficiency_level": "<integer>"
},
{
"skill_id": "<string>",
"skill_name": "<string>",
"proficiency_level": "<integer>"
}
]
},
{
"engagement_id": "<string>",
"direction": "inbound",
"consumer_number": "<string>",
"consumer_id": "<string>",
"consumer_name": "<string>",
"start_time": "<dateTime>",
"results": "declined",
"total_duration": "<long>",
"ivr_duration": "<long>",
"waiting_duration": "<long>",
"talking_duration": "<long>",
"hold_duration": "<long>",
"wrap_up_duration": "<long>",
"disposition_id": "<string>",
"disposition_name": "<string>",
"flows": [
{
"flow_id": "<string>",
"flow_name": "<string>",
"flow_version": "<string>"
},
{
"flow_id": "<string>",
"flow_name": "<string>",
"flow_version": "<string>"
}
],
"queues": [
{
"queue_id": "<string>",
"queue_name": "<string>"
},
{
"queue_id": "<string>",
"queue_name": "<string>"
}
],
"agents": [
{
"user_id": "<string>",
"display_name": "<string>"
},
{
"user_id": "<string>",
"display_name": "<string>"
}
],
"total_flow_duration": "<long>",
"queue_wait_type": "callback",
"last_widget_name": "<string>",
"agent_first_message_speed": "<long>",
"dialed_numbers": [
"<string>",
"<string>"
],
"callback_waiting_duration": "<long>",
"callback_pending_duration": "<long>",
"handling_duration": "<long>",
"ring_duration": "<long>",
"required_skills": [
{
"skill_id": "<string>",
"skill_name": "<string>",
"minimum_proficiency_level": "<integer>"
},
{
"skill_id": "<string>",
"skill_name": "<string>",
"minimum_proficiency_level": "<integer>"
}
],
"optional_skills": [
{
"skill_id": "<string>",
"skill_name": "<string>",
"matched": "<boolean>"
},
{
"skill_id": "<string>",
"skill_name": "<string>",
"matched": "<boolean>"
}
],
"agent_skills": [
{
"skill_id": "<string>",
"skill_name": "<string>",
"proficiency_level": "<integer>"
},
{
"skill_id": "<string>",
"skill_name": "<string>",
"proficiency_level": "<integer>"
}
]
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/analytics/historical/details/metrics?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queue_ids=<string>&queue_ids=<string>&user_id=<string>&consumer_number=<string>&consumer_id=<string>&direction=outbound&results=<string>&results=<string>&channel_types=chat&channel_types=video&queue_wait_type=live_waiting&required_skill_ids=<string>&required_skill_ids=<string>?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queue_ids=<string>&queue_ids=<string>&user_id=<string>&consumer_number=<string>&consumer_id=<string>&direction=outbound&results=<string>&results=<string>&channel_types=chat&channel_types=video&queue_wait_type=live_waiting&required_skill_ids=<string>&required_skill_ids=<string>' -H 'Accept: application/json'
ENDPOINTS