List agent's status history reports
GET {{baseUrl}}/contact_center/analytics/agents/status_history?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queueId=<string>&user_id=<string>&status_id=<string>&sub_status_id=<string>
Generate a list of an agent's status history 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. |
| status_id | string | | The status's ID. |
| sub_status_id | string | | The sub status's ID. |
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","statuses":[{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","status_id":"\u003cstring\u003e","status_name":"Ready","sub_status_id":"\u003cstring\u003e","sub_status_name":"Wrapping up","start_time":"\u003cstring\u003e","end_time":"\u003cstring\u003e","duration":"\u003clong\u003e"},{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","status_id":"\u003cstring\u003e","status_name":"string","sub_status_id":"\u003cstring\u003e","sub_status_name":"Whispering","start_time":"\u003cstring\u003e","end_time":"\u003cstring\u003e","duration":"\u003clong\u003e"}]}