Overview
The User Activity page allows Admins to search specific data from the Agent Monitor through API. It will report the total Agents Available and the total Logged In to the system based on your filters.
Contents
Before You Begin
To learn more about API and Convoso's API Menu options, see API Menu Options Documentation.
There is one required Argument for the vendor's Request Query String:
- API Authentication Token
Note: Our system accepts HTTP POST in RAW format. We do not support nested parameters or multilevel arrays.
Check User Activity via API
1.) Click the API main menu.
2.) Click the User Activity menu option.
The User Activity API page will open.
The User Activity section defines all the Optional and Required arguments for searching Agent activity. The required Arguments are marked in red and are the minimum requirements for the request to work.
Note: When creating a Request Query String, make sure that you have values for the required fields.
Below the Arguments list are the Example PHP Usage and Example JSON Response sections.
3.) Click the Test Request tab to run a test.
4.) Configure the fields for your test insert.
- (A) auth_token: Choose the Authorization Token in the drop-down.
- (B) campaign_id: Enter one or more Campaign IDs to filter Agents based on Campaign.
- (C) queue_id: Enter one or more Queue IDs to filter Agents based on Queue.
- (D) user_id: Enter one or more User IDs to filter Agents based on ID.
-
(E) filter_by_skill_options: Enter one or more skill values to filter Agents based on Skill Routing rules.
- See Configure Skill Routing and Assign to Agent to learn more about Skill Routing.
5.) Check the Show Query checkbox.
6.) Click the green Run button.
7.) Click the Copy to Clipboard button to use the Request Query String.
If everything is configured correctly, the JSON Response will show as a success.
Please sign in and vote to let us know if you found this article helpful!
👇