Overview
Arctera Surveillance supports reporting endpoint APIs to improve reporting and analytics capabilities. Currently there are two types of reporting endpoint APIs:
Submit Report Endpoint: This API executes a request and continue to perform other tasks without waiting for the immediate response from servers. The server processes the requests independently. Client receives a response from Submit Report Endpoint with details to track the request. When the data is ready, the client calls the API to retrieve data. View Report Endpoint returns report status and report data location in response. The client uses this location URL to track the status of report generation and get the data when the report is ready.
They are recommended for large or long-running reports where instead of waiting for report generation to complete, the client submits the request, receives a report ID, and retrieves the completed report later.
View Report Endpoint: This API executes requests in a blocking manner, where each request is processed sequentially. Upon execution of the request, the server waits to complete the first task before proceeding with another tasks. The client remains idle during this time.
They are best suited for reports that can be generated quickly and returned within a single request.
| Report Endpoint | Execution mode | APIs involved | Description |
|---|---|---|---|
| Submit Report Endpoint | Asynchronous | Submit API + View API | Queues the report request and allows you to retrieve the completed report later. |
| View Report Endpoint | Synchronous | Single API | Generates and returns the report in the same request. |
Note: Submit Report Endpoints or Asynchronous APIs use the 'Async' suffix. View Report Endpoints or Synchronous APIs do not include a suffix in the API name. For example, EvidenceOfReview is the synchronous API, whereas EvidenceOfReviewAsync is the corresponding asynchronous API.
Refer to the details below for the supported synchronous and asynchronous APIs.
| API | Sync | Async |
|---|---|---|
| Classification Tags | Supported | Not Supported |
| Content Sources | Supported | Not Supported |
| Departments | Supported | Not Supported |
| Labels | Supported | Not Supported |
| Monitoring Employees | Supported | Not Supported |
| Report Status | Supported | Not Supported |
| Roles | Supported | Not Supported |
| Searches | Supported | Not Supported |
| Users | Supported | Not Supported |
| Evidence of Review | Supported | Supported |
| Item Archived Metrics | Supported | Supported |
| Item Classification Metrics | Supported | Supported |
| Item Details | Supported | Supported |
| Item Hotword Metrics | Supported | Supported |
| Item Label Metrics | Supported | Supported |
| Item Metrics | Supported | Supported |
| Reviewer Assessment Activity Date | Supported | Supported |
| Reviewer Assessment Metrics | Supported | Supported |
| Reviewer Mapping | Supported | Supported |
| User Roles | Supported | Supported |
To utilize these reporting endpoints, the administrator must configure them in Arctera Surveillance. Upon successful configuration, Arctera Surveillance generates a base URL and API keys to ensure secure access to the reporting endpoints.
To securely access data, the primary or secondary API keys serve as passwords, unique to each reporting endpoint configuration. The specified IP addresses during the configuration of these enhanced reporting endpoints are authorized and permitted for API calls.