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: 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. | |
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":"\u003cstring\u003e","page_size":10,"total_records":"\u003cinteger\u003e","timezone":"\u003cstring\u003e","from":"\u003cdateTime\u003e","to":"\u003cdateTime\u003e","agents":[{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","ready_duration":"\u003clong\u003e","ready_percentage":"\u003cinteger\u003e","not_ready_duration":"\u003clong\u003e","not_ready_percentage":"\u003cinteger\u003e","occupied_duration":"\u003clong\u003e","occupied_percentage":"\u003cinteger\u003e","online_duration":"\u003clong\u003e","offline_duration":"\u003clong\u003e","inbound_average_voice_call_talking_duration":"\u003clong\u003e","average_video_call_talking_duration":"\u003clong\u003e","average_wrap_up_duration":"\u003clong\u003e","start_time_interval":"\u003cstring\u003e","end_time_interval":"\u003cstring\u003e","total_outbound_voice_call":"\u003clong\u003e","total_outbound_voice_call_duration":"\u003cdouble\u003e","total_inbound_voice_call":"\u003clong\u003e","total_inbound_voice_call_duration":"\u003cdouble\u003e"},{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","ready_duration":"\u003clong\u003e","ready_percentage":"\u003cinteger\u003e","not_ready_duration":"\u003clong\u003e","not_ready_percentage":"\u003cinteger\u003e","occupied_duration":"\u003clong\u003e","occupied_percentage":"\u003cinteger\u003e","online_duration":"\u003clong\u003e","offline_duration":"\u003clong\u003e","inbound_average_voice_call_talking_duration":"\u003clong\u003e","average_video_call_talking_duration":"\u003clong\u003e","average_wrap_up_duration":"\u003clong\u003e","start_time_interval":"\u003cstring\u003e","end_time_interval":"\u003cstring\u003e","total_outbound_voice_call":"\u003clong\u003e","total_outbound_voice_call_duration":"\u003cdouble\u003e","total_inbound_voice_call":"\u003clong\u003e","total_inbound_voice_call_duration":"\u003cdouble\u003e"}]}