Arctera™ Insight Surveillance User Guide
- Introducing Arctera Insight Surveillance
- Getting started
- Working with dashboard widgets
- Managing employee groups
- Managing departments
- Managing department users
- Managing department-level searches
- Managing department-specific hotword sets
- Managing department-specific labels
- Managing department-specific trash rules
- Managing department-specific allowlist rules
- Managing department-specific review comments
- Viewing employees associated with departments
- Managing users, roles, and permissions
- Managing application-level searches
- Managing application-specific hotword sets
- Managing application-specific labels
- Managing application-specific trash rules
- Managing application-specific allowlist rules
- Managing application-specific review comments
- Managing data requests
- Managing search schedules
- Managing export operations
- Managing reviews
- Working with reports
- Enhanced reporting
- Departments API
- Users API
- UserRoles API
- Roles API
- Classification Tags API
- Labels API
- Searches API
- ItemMetrics API
- ReviewerMapping API
- MonitoredEmployees API
- Evidence of Review API
- Item Classification Metrics API
- Item Label Metrics API
- Item Archived Metrics API
- Managing Power BI templates for reporting APIs
- Managing Audit Settings
- Working with Audit viewer
Enhanced reporting
Insight Surveillance has introduced 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.
: 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. Insight 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.
Departments API
https://<Reporting endpoint Base URL>/odata/departments)
: Supported (: Not supported
Roles API
https://<Reporting endpoint Base URL>/odata/roles)
: Supported (: Not supported
Users API
https://<Reporting endpoint Base URL>/odata/users)
: Supported (: Not supported
UserRoles API
https://<Reporting endpoint Base URL>/odata/userroles)
: Supported (: Not supported
Classification Tags API
https://<Reporting endpoint Base URL>/odata/ClassificationTags)
: Supported (: Not supported
Labels API
https://<Reporting endpoint Base URL>/odata/Labels)
: Supported (: Not supported
Searches API
https://<Reporting endpoint Base URL>/odata/Searches)
: Supported (: Not supported
ItemMetrics API
https://<Reporting endpoint Base URL>/odata/itemmetrics)
: Supported (: Not supported
ReviewerMapping API
https://<Reporting endpoint Base URL>/odata/reviewermapping)
: Supported (: Not supported
MonitoredEmployees API
https://<Reporting endpoint Base URL>/odata/monitoredemployees)
: Supported (: Not supported
EvidenceOfReview API
https://<Reporting endpoint Base URL>/odata/EvidenceOfReview)
: Supported (https://<Reporting endpoint Base URL>/odata/EvidenceOfReviewAsync)
: Supported (
ItemClassificationMetrics API
https://<Reporting endpoint Base URL>/odata/ItemClassificationMetrics)
: Supported (https://<Reporting endpoint Base URL>/odata/ItemClassificationMetricsAsync)
: Supported (
ItemLabelMetrics API
https://<Reporting endpoint Base URL>/odata/ItemLabelMetrics)
: Supported (https://<Reporting endpoint Base URL>/odata/ItemLabelMetricsAsync)
: Supported (
ItemArchivedMetrics API
https://<Reporting endpoint Base URL>/odata/ItemArchivedMetrics)
: Supported (https://<Reporting endpoint Base URL>/odata/ItemArchivedMetricsAsync)
: Supported (
ReportStatus API
https://<Reporting endpoint Base URL>/odata/reportstatus)
: Supported (: Not supported
To utilize these reporting endpoints, the administrator must configure them in Insight Surveillance. Upon successful configuration, Insight 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 Labels API.
See Searches API.