Monitored Employees API
Overview
The Monitored Employees API returns the monitoring percentage configured for each message type of every monitored employee across departments. The API supports both HTTP GET and POST methods.
Endpoint URLs
-
GET https://<Reporting endpoint Base URL>/odata/MonitoredEmployees?Departments=[list of comma-separated values] -
POST https://<Reporting endpoint Base URL>/odata/MonitoredEmployees
Sample requests
-
GET https://<Reporting endpoint Base URL>/odata/MonitoredEmployees?Departments=[1,2,4,7] -
POST https://<Reporting endpoint Base URL>/odata/MonitoredEmployees
Parameters / Filters
Specify the following filters to obtain refined and selective results from this report.
| Name | Required | Description |
|---|---|---|
| Departments | Optional | Specifies IDs of the departments to get monitoring percentage details for all message types for each monitored employee in the departments. |
| If Department IDs are specified, the result returns details for those departments only. | ||
| If Department IDs are not specified, the result returns details for every available department. | ||
| Data Type: JSON array of integers 'id' (identifier fields) that is Departments. | ||
| Note: To get the Department IDs, see Departments API. Refer to the 'departmentId' field only. |
Scenario 1: To get the monitored employees level monitoring percentages for a specified single department
Input:
Scenario 2: To get the monitored employees level monitoring percentages for specified list of departments.
Input:
Scenario 3: To get the monitored employees level monitoring percentages for all departments
Input:
Scenario 4: To get the monitored employees level monitoring percentages for all departments
Input:
Sample responses
Sample response for scenarios 1 to 4 are as follows:
Status code: 200 OK
Supported OData Filters
Responses
See Responses.