How to view all the data on Agent Monitor and log out a user through API. 

From the Admin dashboard, click on API and select Agent Monitor.

To search, click on Agent Monitor Search. Check the Arguments used to search for Campaign, Queue, and Users.

 

This section will also display an Example PHP Usage and an Example JSON Response.

To make a Test Request, you need to have an Authorization Token first. (Click this link on How to Manage or add an Authorization Token)

Note: Make sure that on your Authorization Token, Revenue Agent Monitor Search/Logout is checked or enabled.

If you would like to verify that Agent Monitor search works via API, click on the Test Request tab.

auth_token - select the generated authentication token.
url - pre-populated with the API Url String.
type - type of request
campaign_id - campaign id number
queue_id - queue id number
user_id - user id number

The Request Query String and the Example JSON Response is shown below:

 

To Force Log Out a user through API

This will guide you on how to force log out a user on Agent Monitor through API.

From the Agent Monitor API, click on the Agent Monitor Logout tab. Check the Arguments used to force log out a user from a campaign.

This section will also display an Example PHP Usage and an Example JSON Response.

To make a Test Request, you need to have an Authorization Token first. (Click this link on How to Manage or add an Authorization Token)

Note: Make sure that on your Authorization Token, Revenue Agent Monitor Search/Logout is checked or enabled.

If you would like to verify that Agent Monitor Logout works via API, click on the Test Request tab.

auth_token - select the generated authentication token.
url - pre-populated with the API Url String.
type - type of request
user_id - user id number

The Request Query String and the Example JSON Response is shown below: