Enhanced reporting (API mode)
Arctera Surveillance supports reporting endpoint APIs to improve reporting and analytics capabilities. Currently there are two types of reporting endpoint APIs.
Synchronous API: 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.
Asynchronous API: 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 asynchronous API with details to track the request. When the data is ready, the client calls the API to retrieve data. Arctera Surveillance reporting asynchronous API 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.
Synchronous APIs do not possess suffix after the API name. However, asynchronous APIs are indicated with the "Async" as a suffix. For example, EvidenceOfReview is synchronous API name and EvidenceOfReviewAsync is the asynchronous API name.
Refer to the details below for the available synchronous and asynchronous APIs.
-
Classification Tags API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ClassificationTags) -
Asynchronous method: Not supported
-
-
Content Sources API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/contentsources) -
Asynchronous method: Not supported
-
-
Departments API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/departments) -
Asynchronous method: Not supported
-
-
Labels API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/Labels) -
Asynchronous method: Not supported
-
-
MonitoredEmployees API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/monitoredemployees) -
Asynchronous method: Not supported
-
-
ReportStatus API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/reportstatus) -
Asynchronous method: Not supported
-
-
Roles API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/roles) -
Asynchronous method: Not supported
-
-
Searches API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/Searches) -
Asynchronous method: Not supported
-
-
Users API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/users) -
Asynchronous method: Not supported
-
-
EvidenceOfReview API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/EvidenceOfReview) -
Asynchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/EvidenceOfReviewAsync)
-
-
ItemArchivedMetrics API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemArchivedMetrics) -
Asynchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemArchivedMetricsAsync)
-
-
ItemClassificationMetrics API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemClassificationMetrics) -
Asynchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemClassificationMetricsAsync)
-
-
ItemDetails API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemDetails) -
Asynchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemDetailsAsync)
-
-
ItemHotwordMetrics API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemHotwordMetrics) -
Asynchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemHotwordMetricsAsync)
-
-
ItemLabelMetrics API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemLabelMetrics) -
Asynchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemLabelMetricsAsync)
-
-
ItemMetrics API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/itemmetrics) -
Asynchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ItemMetricsAsync)
-
-
ReviewerAssessmentMetrics API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ReviewerAssessmentMetrics) -
Asynchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/ReviewerAssessmentMetricsAsync)
-
-
ReviewerMapping API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/reviewermapping) -
Asynchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/reviewermappingAsync)
-
-
UserRoles API
-
Synchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/userroles) -
Asynchronous method: Supported (
https://<Reporting endpoint Base URL>/odata/userrolesAsync)
-
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.
See Item Details API.
See Reviewer Mapping API.
See User Roles Async API.
See User Roles API.
More Information
Related information
Working with reports
Configuring a reporting endpointAuthenticationClassification Tags APIContent Sources APIDepartments APILabels APIMonitored Employees APIReport Status APIRoles APISearches APIUsers APIEvidence Of Review Async APIEvidence of Review APIItem Archived Metrics Async APIItem Archived Metrics APIItem Classification Metrics Async APIItem Classification Metrics APIItem Details Async APIItem Details APIItem Hotword Metrics Async APIItem Hotword Metrics APIItem Label Metrics Async APIItem Label Metrics APIItem Metrics Async APIItem Metrics APIReviewer Assessment Metrics Async APIReviewer Assessment Metrics APIReviewer Mapping Async APIReviewer Mapping APIUser Roles Async APIUser Roles APISupported OData query optionsSupported reporting endpoint API filters and their valuesResponses