Arctera™ Insight Surveillance User Guide
- Introducing Arctera Insight Surveillance
- Getting started
- Working with dashboard widgets
- Managing employee groups
- Managing departments
- About departments
- Understanding the Departments page
- Searching departments
- Creating departments
- Moving existing departments under other departments
- Adding monitored employees and employee groups to departments
- Editing monitoring policies
- Editing department details and monitoring policy
- Managing exception employees
- Designating employees as exception employee
- Assigning further exception reviewers to an exception employee
- Removing exception status
- Removing exception reviewers
- 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
- Overview
- Predefined user roles and permissions
- Adding new roles for users (employees) and employee groups
- Editing user roles and permissions
- Deleting user roles
- Assigning Insight Surveillances to users (employees) and employee groups
- Restricting users to use hotwords in searches
- Removing a user role
- 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
- About reviewing with Insight Surveillance
- Limitations on reviewing certain types of Skype for Business content
- Understanding the Review page
- Changing the Preview pane position
- Rearranging columns in the item list pane
- Filtering the items in the Review pane
- Viewing dynamic review item counts on the calendar
- Reviewing searched items
- Translating email and attachment content for review
- Adding or removing text for machine learning
- Assigning review status to items
- Viewing hotwords highlighting
- Viewing hotwords in collaboration message
- Viewing tags highlighting
- Viewing predicted labels of review items
- Viewing the full content in a new window
- Adding comments to items
- Escalating the review items
- Applying labels to items
- Viewing history of items
- Printing and downloading the items and attachments
- Viewing Intelligent Review Details
- Working with reports
- About Insight Surveillance reports
- Predefined reports
- Enhanced reporting
- Configuring a reporting endpoint
- Authentication
- Departments API
- Users API
- UserRoles API
- Roles API
- Classification Tags API
- Labels API
- Searches API
- ItemMetrics API
- ReviewerMapping API
- MonitoredEmployees API
- Evidence Of Review Async API
- Evidence of Review API
- Item Classification Metrics Async API
- Item Classification Metrics API
- Item Label Metrics Async API
- Item Label Metrics API
- Item Archived Metrics Async API
- Item Archived Metrics API
- Report Status API
- Supported OData query options
- Supported reporting endpoint API filters and their values
- Responses
- Managing Power BI templates for reporting APIs
- Accessing Insight Surveillance reports and datasets through the OData web service
- Guidelines for using Insight Surveillance templates with Microsoft Power BI Desktop
- TEMPLATE - Departments, Users, Roles, Labels
- TEMPLATE - User Roles
- TEMPLATE - Item Metrics
- TEMPLATE - Reviewer Mapping
- TEMPLATE - Searches
- TEMPLATE- Item Classification Metrics - Submit report request
- TEMPLATE- Item Classification Metrics - View report data
- TEMPLATE- Item Archived Metrics - Submit report request
- TEMPLATE- Item Archived Metrics - View report data
- TEMPLATE- Item Label Metrics - Submit report request
- TEMPLATE- Item Label Metrics By Employee - View report data
- TEMPLATE- Item Label Metrics By Department - View report data
- TEMPLATE- Evidence Of Review - Submit report request
- TEMPLATE- Evidence Of Review By Monitored Employee - View report data
- TEMPLATE- Evidence Of Review By Department - View report data
- TEMPLATE- Evidence Of Review With Item Archived Metrics - Submit report request
- TEMPLATE- Evidence Of Review With Item Archived Metrics - View report data
- Saving, editing, and refreshing the Power BI reports
- Managing Audit Settings
- Working with Audit viewer
Item Classification Metrics Async API
ItemClassificationMetricsAsync | This API submits the report generation request which executes asynchronously. The result of this API contains the identifier for the report, status, and location for retrieving the report data. The report identifier and locations in the result can be used to track the report generation operation. |
To use the ItemClassificationMetricsAsync API, follow the steps below:
Call the ItemClassificationMetricsAsync API to submit a report generation request.
This asynchronous API supports GET and POST query methods. Use any of the following as needed:
GET https://<Reporting endpoint base URL>/OData/ItemClassificationMetricsAsync?ReportName=<Name of the report>&StartDate=<YYYY-MM-DD>&EndDate=<YYYY-MM-DD>
POST https://<Reporting endpoint base URL>/OData/ItemClassificationMetricsAsync
GET https://<Reporting endpoint Base URL>/odata/ ItemClassificationMetricsAsync?ReportName=<Name of the report>&StartDate= <YYYY-MM-DD>&EndDate=<YYYY-MM-DD>&Departments=[<DeptID1>,<DeptID2>,...] &Tags=[<tagId1>,<tagId2>...]
POST https://<Reporting endpoint base URL>/OData/ItemClassificationMetricsAsync
The following parameters/filters can be used with the ItemClassificationMetricsAsync API when invoked using the GET and POST methods. The system uses the AND operator between the filters to return the result based on the specified filters.
ReportName
Mandatory
Specify the name of the report you want to generate.
The report name can be up to a maximum of 256 characters long.
Special characters are not allowed; only alphanumeric values are permitted.
StartDate
Mandatory
StartDate refers to the date items are captured or ingested in Insight Surveillance and recorded as their CaptureDate.
Specify the start date to return the count of items with a CaptureDate on or after this date.
Date in the YYYY-MM-DD format that is StartDate.
For the cloud-based application, a maximum of one year duration is allowed.
EndDate
Mandatory
Specify the end date to return the count of items with a CaptureDate on or before this date.
Date in the YYYY-MM-DD format that is StartDate.
For the cloud-based application, a maximum of one year duration is allowed.
Departments
Optional
Specifies the departments to which the captured item belongs and returns item counts for items within that department.
JSON array of integers 'id'(identifier fields) that is Department IDs.
As an input, this API can pass maximum of 1000 Departments IDs.
To include results for all departments of a specified tenant/customer in a report, do not specify any department IDs in a query.
To include results for specific departments of a specified tenant/customer in a report, specify department IDs in the query.
Note:
To get the Department IDs, See Departments API. Refer to the field only.
Tags
Optional
Specifies the classification tags of the captured items and returns item counts for those tags.
JSON array of integers 'id'(identifier fields) that is Tag IDs.
As an input, this API can pass maximum of 1000 Tag IDs.
To include results for all the classification tags of a specified tenant/customer in a report, do not specify any classification tag ID in a query.
To include results for specific classification tag IDs of a specified tenant/customer in a report, specify classification tag IDs in the query.
Note:
To get the Tag IDs, See Classification Tags API. Refer to the field only.
Name
Description
reportId
Displays report ID. It is generated upon successful execution of API.
reportName
Displays report name. It is generated upon successful execution of API.
reportType
Displays the report type as Item Classification Metrics.
reportDate
Displays the date of report generation after successful execution of API.
reportStatus
Displays report status. For more information on statuses, See Report Status API.
info
Displays a message if the report request has queued successfully or not.
newReportInstanceQueued
Specifies weather a new report generation request has been submitted or not. The Rate Limiting feature restricts submission of multiple requests with identical input parameters if attempted within one minute.
It returns the following values:
: The value is shown as True, if the new report request has been queued successfully.
: The value is shown as False, if the input parameters of the current request are identical to the parameters of the already submitted request within one minute, a new report will not be queued. As a result, the details of the existing report request are returned.
reportStatusLocation
Displays a URL with report ID.
To view the status of this report, use the same URL.
reportDataLocation
Displays a URL for the location of report data.
To access the report data, use the same URL.
Call the ReportStatus API to get the status of the ItemClassificationMetricsAsync API report. See Report Status API.
Once the report is ready, call the ItemClassificationMetrics API to retrieve the report data from the asynchronous API. See Item Classification Metrics API.
