Zoom Public API Documentation
List agent's time sheet reports
GET {{baseUrl}}/contact_center/analytics/agents/time_sheets?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queueId=<string>&user_id=<string>&interval=1_week
Generate a list of an agent's time sheet 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. | |
queueId
|
string | The queue's ID. | |
user_id
|
string | The agent's ID. | |
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>",
"ready_duration": "<long>",
"ready_percentage": "<integer>",
"not_ready_duration": "<long>",
"not_ready_percentage": "<integer>",
"occupied_duration": "<long>",
"occupied_percentage": "<integer>",
"online_duration": "<long>",
"offline_duration": "<long>",
"inbound_average_voice_call_talking_duration": "<long>",
"average_video_call_talking_duration": "<long>",
"average_wrap_up_duration": "<long>",
"start_time_interval": "<string>",
"end_time_interval": "<string>",
"total_outbound_voice_call": "<long>",
"total_outbound_voice_call_duration": "<double>",
"total_inbound_voice_call": "<long>",
"total_inbound_voice_call_duration": "<double>"
},
{
"user_id": "<string>",
"display_name": "<string>",
"ready_duration": "<long>",
"ready_percentage": "<integer>",
"not_ready_duration": "<long>",
"not_ready_percentage": "<integer>",
"occupied_duration": "<long>",
"occupied_percentage": "<integer>",
"online_duration": "<long>",
"offline_duration": "<long>",
"inbound_average_voice_call_talking_duration": "<long>",
"average_video_call_talking_duration": "<long>",
"average_wrap_up_duration": "<long>",
"start_time_interval": "<string>",
"end_time_interval": "<string>",
"total_outbound_voice_call": "<long>",
"total_outbound_voice_call_duration": "<double>",
"total_inbound_voice_call": "<long>",
"total_inbound_voice_call_duration": "<double>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/analytics/agents/time_sheets?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queueId=<string>&user_id=<string>&interval=1_week?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queueId=<string>&user_id=<string>&interval=1_week' -H 'Accept: application/json'
ENDPOINTS