User Status Report
The Reporting API has been replaced by the Explore API. Talkdesk strongly encourages the transition to the Explore API. You may still use the Reporting API, but please note:
- Talkdesk will only provide support (no SLA for bug fixing or outage recovery) until June 1, 2022.
- The Reporting API endpoint will stop responding to requests on December 1, 2022.
Overview
The User Status report provides a raw log of agent status changes occurring in Talkdesk®.
Usage
Specify user_status type in the Reporting API path: /reports/user_status/jobs
| Field | Description |
|---|---|
| user_id string | Unique identifier of the user who underwent the status change |
| user_name string | Full name of the user who underwent the status change |
| user_email | Email of the user who underwent the status change |
| status_label string | Label assigned to the status |
| status_start_at datetime | Start datetime of this status session |
| status_end_at datetime | End datetime of this status session |
| status_time int | Total duration of the time spent in this status by the user (in seconds) |
| is_user_active boolean | Whether the user is active in Talkdesk |
| team_id string | The team the agent was on when the status change occurred (null if the agent wasn't on a team) |
| team_name string | The team the agent was on when the status change occurred (null if the agent wasn't on a team) |
{
"total": 2,
"type": "user_status",
"version": "v1",
"entries": [
{
"user_name": "Robert Sur",
"user_email": "[email protected]",
"user_id": "13da-3ccd-3423",
"status_label": "Away",
"status_start_at": "2016-01-29 10:30:00",
"status_end_at": "2016-01-29 10:30:14",
"status_time": 14,
"is_user_active": true,
"team_id": "69bd4bed944f4de99cb79736f2ca15b1"
"team_name": "Admin"
},
{
"user_name": "Robert Sur",
"user_email": "[email protected]",
"user_id": "13da-3ccd-3423",
"status_label": "On A Call",
"status_start_at": "2016-01-29 10:30:15",
"status_end_at": "2016-01-29 10:31:15",
"status_time": 60,
"is_user_active": false,
"team_id": "69bd4bed944f4de99cb79736f2ca15b1"
"team_name": "Admin"
}
]
}
User Status Data Availability
User status data from as far back as 2016 is available in this report type.
Troubleshooting
If you have questions or technical issues, please open a ticket using this form.
Updated 10 months ago