Arctera™ Insight Surveillance User Guide

Last Published:
Product(s): Veritas Alta Surveillance (1.0)
  1. Introducing Arctera Insight Surveillance
    1.  
      About Insight Surveillance
    2.  
      Insight Surveillance multi-tier architecture
    3.  
      System requirements
    4.  
      Sampling support for content sources
    5.  
      AI-based label predictions support for efficient review process
    6.  
      Date format support in Insight Surveillance
    7.  
      About Insight Surveillance system security
  2. Getting started
    1.  
      Signing in to Insight Surveillance
    2.  
      Signing out from Insight Surveillance
    3.  
      Launching Arctera Insight Archiving applications
    4.  
      Resetting a forgotten password
  3. Working with dashboard widgets
    1.  
      Understanding the Dashboard page
    2.  
      Viewing status summary of recently reviewed departments
    3.  
      Pinning and unpinning departments to view review status
    4.  
      Changing the order of pinned departments
    5.  
      Viewing the review status summary of escalated items
    6.  
      Viewing a summary of searches and exports
  4. Managing employee groups
    1. Creating custom employee group
      1.  
        Editing custom employee group details
    2.  
      Adding employee groups
  5. Managing departments
    1.  
      About departments
    2.  
      Understanding the Departments page
    3.  
      Searching departments
    4.  
      Creating departments
    5.  
      Moving existing departments under other departments
    6.  
      Adding monitored employees and employee groups to departments
    7.  
      Editing monitoring policies
    8.  
      Editing department details and monitoring policy
    9.  
      Managing exception employees
    10.  
      Designating employees as exception employee
    11.  
      Assigning further exception reviewers to an exception employee
    12.  
      Removing exception status
    13.  
      Removing exception reviewers
  6. Managing department users
    1.  
      Assigning users to departments
    2.  
      Removing users from departments
    3.  
      Adding new roles for users
    4.  
      Removing roles
    5. Managing role assignment for a user in departments
      1.  
        Assigning departments and exceptions to specific users
      2.  
        Removing a specific role to users in one or more departments and exceptions
  7. Managing department-level searches
    1.  
      About department-level searches
    2.  
      Guidelines for effective searches
    3.  
      Creating and running department-level searches
    4.  
      Disabling scheduled searches
    5.  
      Using proximity searches
    6.  
      Previewing search results
    7.  
      Accepting search results
    8.  
      Rejecting a search result
    9.  
      Resubmitting a search
  8. Managing department-specific hotword sets
    1.  
      Overview
    2.  
      Creating department-specific hotword sets
    3.  
      Editing department-specific hotwords and hotword sets
    4.  
      Deleting department-specific hotword sets
  9. Managing department-specific labels
    1.  
      Searching department-specific labels, label groups, and single choice groups
    2.  
      Managing department-specific labels
    3.  
      Managing department-specific label groups
    4.  
      Managing department-specific single choice label groups
  10. Managing department-specific trash rules
    1.  
      Overview
    2.  
      Creating department-specific trash rules
    3.  
      Activating department-specific trash rules
    4.  
      Deactivating department-specific trash rules
    5.  
      Propagating department-specific trash rules
    6.  
      Unpropagating department-specific trash rules
  11. Managing department-specific allowlist rules
    1.  
      Overview
    2.  
      Creating department-specific allowlist rules
    3.  
      Editing department-specific allowlist rules
  12. Managing department-specific review comments
    1.  
      About department-level review comments
    2.  
      Adding department-level review comments
    3.  
      Editing department-level review comments
    4.  
      Deleting department-level review comments
    5.  
      Updating order of department-level review comments
  13. Viewing employees associated with departments
    1.  
      Viewing employee association history
  14. Managing users, roles, and permissions
    1.  
      Overview
    2.  
      Predefined user roles and permissions
    3.  
      Adding new roles for users (employees) and employee groups
    4.  
      Editing user roles and permissions
    5.  
      Deleting user roles
    6.  
      Assigning Insight Surveillances to users (employees) and employee groups
    7.  
      Restricting users to use hotwords in searches
    8.  
      Removing a user role
  15. Managing application-level searches
    1.  
      About application-level searches
    2.  
      Viewing existing application-level searches
    3.  
      Creating and running application-level searches
    4.  
      Editing application-level searches
    5.  
      Excluding departments from application searches
    6.  
      Reinstating the excluded department for application searches
  16. Managing application-specific hotword sets
    1.  
      Overview
    2.  
      Creating application-specific hotword sets
    3.  
      Editing application-specific hotwords and hotword sets
    4.  
      Deleting application-specific hotword sets
  17. Managing application-specific labels
    1.  
      Searching application-specific labels, label groups, and single choice groups
    2.  
      Managing application-specific labels
    3.  
      Managing application-specific label groups
    4.  
      Managing application-specific single choice label groups
  18. Managing application-specific trash rules
    1.  
      Overview
    2.  
      Creating application-specific trash rules
    3.  
      Activating application-specific trash rules
    4.  
      Deactivating application-specific trash rules
    5.  
      Propagating application-specific trash rules
    6.  
      Unpropagating application-specific trash rules
  19. Managing application-specific allowlist rules
    1.  
      Overview
    2.  
      Creating application-specific allowlist rules
    3.  
      Editing application-specific allowlist rules
  20. Managing application-specific review comments
    1.  
      About application-level review comments
    2.  
      Adding application-level review comments
    3.  
      Editing application-level review comments
    4.  
      Deleting application-level review comments
    5.  
      Updating order of application-level review comments
  21. Managing data requests
    1.  
      About data request
    2.  
      Creating a new data request
  22. Managing search schedules
    1.  
      Overview
    2.  
      Setting up new search schedules
    3.  
      Setting up one-time search schedules
    4.  
      Example of a one-time search schedule
    5.  
      Setting up recurring search schedules
    6.  
      Example of a recurring search schedule
    7.  
      Editing search schedules
    8.  
      Deleting search schedules
  23. Managing export operations
    1.  
      About exporting items
    2.  
      Performing export runs
  24. Managing reviews
    1.  
      About reviewing with Insight Surveillance
    2.  
      Limitations on reviewing certain types of Skype for Business content
    3.  
      Understanding the Review page
    4.  
      Changing the Preview pane position
    5.  
      Rearranging columns in the item list pane
    6.  
      Filtering the items in the Review pane
    7.  
      Viewing dynamic review item counts on the calendar
    8.  
      Reviewing searched items
    9.  
      Translating email and attachment content for review
    10.  
      Translating collaboration message for review
    11.  
      Adding or removing text for machine learning
    12.  
      Assigning review status to items
    13.  
      Viewing hotwords highlighting
    14.  
      Viewing hotwords in collaboration message
    15.  
      Viewing tags highlighting
    16.  
      Viewing predicted labels of review items
    17.  
      Viewing the full content in a new window
    18.  
      Adding comments to items
    19.  
      Escalating the review items
    20.  
      Applying labels to items
    21.  
      Viewing history of items
    22.  
      Printing and downloading the items and attachments
    23.  
      Viewing Intelligent Review Details
  25. Working with reports
    1.  
      About Insight Surveillance reports
    2.  
      Predefined reports
    3. Enhanced reporting
      1.  
        Configuring a reporting endpoint
      2.  
        Authentication
      3. Departments API
        1.  
          Departments - List
      4. Users API
        1.  
          Users - List
      5. Roles API
        1.  
          Roles - List
        2.  
          Roles - List by filters
      6.  
        User Roles Async API
      7. User Roles API
        1.  
          UserRoles - List
      8. Classification Tags API
        1.  
          Classification Tags - List
      9. Labels API
        1.  
          Labels - List
      10. Searches API
        1.  
          Searches - List
      11. ItemMetrics API
        1.  
          ItemMetrics - List
        2.  
          ItemMetrics - List by filter
      12.  
        Reviewer Mapping Async API
      13. Reviewer Mapping API
        1.  
          ReviewersMapping - List
      14. MonitoredEmployees API
        1.  
          MonitoredEmployees - List
      15.  
        Evidence Of Review Async API
      16. Evidence of Review API
        1.  
          EvidenceOfReview - List by filter
      17.  
        Item Classification Metrics Async API
      18. Item Classification Metrics API
        1.  
          ItemClassificationMetrics - List by filter
      19.  
        Item Label Metrics Async API
      20. Item Label Metrics API
        1.  
          ItemLabelMetrics - List by filter
      21.  
        Item Archived Metrics Async API
      22. Item Archived Metrics API
        1.  
          ItemArchivedMetrics - List by filter
      23.  
        Item Hotword Metrics Async API
      24. Item Hotword Metrics API
        1.  
          ItemHotwordMetrics - List by filter
      25.  
        Item Details Async API
      26. Item Details API
        1.  
          ItemDetails - List by filter
      27.  
        Reviewer Assessment Metrics Async API
      28. Reviewer Assessment Metrics API
        1.  
          Reviewer Assessment Metrics- List by filter
      29.  
        Report Status API
      30.  
        Supported OData query options
      31.  
        Supported reporting endpoint API filters and their values
      32.  
        Responses
    4. Managing Power BI templates for reporting APIs
      1.  
        Accessing Insight Surveillance reports and datasets through the OData web service
      2.  
        Guidelines for using Insight Surveillance templates with Microsoft Power BI Desktop
      3.  
        TEMPLATE - Departments, Users, Roles, Labels
      4.  
        TEMPLATE - User Roles - Submit Report Request
      5.  
        TEMPLATE - User Roles - View Report Data
      6.  
        TEMPLATE - Item Metrics
      7.  
        TEMPLATE - Reviewer Mapping - Submit Report Request
      8.  
        TEMPLATE - Reviewer Mapping - View Report Data
      9.  
        TEMPLATE - Searches
      10.  
        TEMPLATE- Item Classification Metrics - Submit Report Request
      11.  
        TEMPLATE- Item Classification Metrics - View Report Data
      12.  
        TEMPLATE- Item Archived Metrics - Submit Report Request
      13.  
        TEMPLATE- Item Archived Metrics - View Report Data
      14.  
        TEMPLATE- Item Label Metrics - Submit Report Request
      15.  
        TEMPLATE- Item Label Metrics By Employee - View Report Data
      16.  
        TEMPLATE- Item Label Metrics By Department - View Report Data
      17.  
        TEMPLATE- Item Hotword Metrics - Submit Report Request
      18.  
        TEMPLATE- Item Hotword Metrics - View Report Data
      19.  
        TEMPLATE- Item Details - Submit Report Request
      20.  
        TEMPLATE- Item Details - View Report Data
      21.  
        TEMPLATE- Reviewer Assessment Metrics - Submit Report Request
      22.  
        TEMPLATE- Reviewer Assessment Metrics - View Report Data
      23.  
        TEMPLATE- Evidence Of Review - Submit Report Request
      24.  
        TEMPLATE- Evidence Of Review By Monitored Employee - View Report Data
      25.  
        TEMPLATE- Evidence Of Review By Department - View Report Data
      26.  
        TEMPLATE- Evidence Of Review With Item Archived Metrics - Submit Report Request
      27.  
        TEMPLATE- Evidence Of Review With Item Archived Metrics - View Report Data
      28.  
        Saving, editing, and refreshing the Power BI reports
  26. Managing Audit Settings
    1.  
      Audit Settings Overview
    2.  
      Editing the Audit Settings
  27. Working with Audit viewer
    1.  
      About Audit viewer
    2.  
      Performing a search for audit records

Reviewer Assessment Metrics Async API

Reviewer Assessment Metrics Async

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.

This report displays metrics for actions performed by reviewers within the Insight Surveillance application. These actions include marking, labeling, escalating, and appraising items. The report is intended to assess reviewer performance based on the accuracy of their reviews.

The report identifier and locations in the result can be used to track the report generation operation.

To use the Reviewer Assessment Metrics Async API, follow the steps below:

  1. Call the Reviewer Assessment Metrics Async 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/ ReviewerAssessmentMetricsAsync?ReportName=<Name of the report>&StartDate=<YYYY-MM-DD>& EndDate=<YYYY-MM-DD>

    • POST https://<Reporting endpoint base URL>/OData/ ReviewerAssessmentMetricsAsync

    Sample Request

    • GET https://<Reporting endpoint Base URL>/odata/ ReviewerAssessmentMetricsAsync?StartDate=2025-04-23&

      EndDate=2025-05-31&ReportName=SampleReviewerAssessReport

    • POST https://<Reporting endpoint base URL>/OData/ReviewerAssessmentMetricsAsync

    Reviewer Assessment Metrics Async API - URL Parameter/Filters

    The following parameters/filters can be used with the Reviewer Assessment Metrics Async 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.

    Data Type: String

    Limitations

    • 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 beginning of the datetime used to filter items in Insight Surveillance. It specifies emails with a 'sent date' greater than or equal to the specified value.

    Data Type: DateTime

    Notes:

    1. Format is YYYY-MM-DDThh:mm:ss.

    The time component is optional. If you prefer not to include the time, you can simply use the YYYY-MM-DD format.

    2. StartDate must be earlier than EndDate.

    Limitations

    For the cloud-based application, a maximum of one year duration is allowed.

    EndDate

    Mandatory

    EndDate refers to the end of the datetime used to filter items in Insight Surveillance. It specifies emails with a 'sent date' less than or equal to the specified value.

    Data Type: DateTime

    Notes:

    1. Format is YYYY-MM-DDThh:mm:ss.

    The time component is optional. If you prefer not to include the time, you can simply use the YYYY-MM-DD format.

    2. EndDate must be later than StartDate.

    Limitations

    For the cloud-based application, a maximum of one year duration is allowed.

    Departments

    Optional

    Specifies the departments to which the item belongs and returns item counts for items within that department.

    Data Type: JSON array of integers id (identifier fields) that is Department IDs.

    Limitation

    As an input, this API can pass maximum of 1000 Departments IDs.

    • To include results for all departments of a specified customer in a report, do not specify any department IDs in a query.

    • To include results for specific departments of a specified customer in a report, specify department IDs in the query.

    Note:

    To get the Department IDs, See Departments API. Refer to the departmentId field only.

    Reviewers

    Optional

    Specify a list of UserIDs for the reviewers whose details you want to retrieve.

    Data Type: JSON array of integers 'id'(identifier fields) that is Reviewer IDs

    Limitation

    As an input, this API can pass maximum of 100 reviewers.

    Note:

    The valid value of the Reviewer is an ID of any user from the Insight Surveillance User ID list. The User ID list can be fetched from the Users API endpoint. See Users API. Refer to the userId field only.

    MessageTypes

    Optional

    Specifies the type of captured items and returns item counts for items that have the specified message type.

    Data Type: JSON array of integers 'id' (identifier fields) that is MessageTypes IDs.

    Limitation

    As an input, the Reviewer Assessment Metrics API can pass maximum 100 MessageTypes IDs on a single page.

    Note:

    If no optional parameters are specified (such as in the GET request), the Reviewer Assessment Metrics API returns counts for all Departments, Reviewers, and MessageTypes.

    Primary actions and corresponding API behavior

    • Marking: All marking actions, such as ReviewedRelevant, ReviewedIrrelevant, Questioned, Pending, are counted against the reviewer who performed the action. However, if a reviewer performs multiple markings on the same item, only the last marking action is considered. For example, if an item is first marked as Questioned and later changed to Pending, only the Pending action is counted. Each item retains only one marking at a time, based on the most recent action.

    • Escalation: When a reviewer escalates an item, the escalation count is attributed solely to that reviewer. However, an item can be escalated multiple times, but for reporting purposes, only the first escalation is considered. The escalation count is attributed solely to the initial reviewer who triggered it. Subsequent re-escalations by other reviewers are not included in the report.

    • Appraise and Label: For Appraise and Label actions, the count is attributed to the first reviewer who took any action on the item (marking, escalating, appraising, labeling), not the reviewer who performed the appraise or label action. This differs from Mark and Escalate, where the count goes to the reviewer who actually performed the action. Even if Reviewer X appraises or labels an item, the count will reflect under the original reviewer who first interacted with the item.

    Scenario 1: A new request to submit the report

    Sample request:

    Sample response:

    Refer to the table below for details on the attributes included in the ReviewerAssessmentMetricsAsync API response.

    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 Details.

    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 whether 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:

    True: The value is shown as True, if the new report request has been queued successfully.

    False: 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.

    Scenario 2: A new request to submit the report when optional parameters are omitted

    Sample request:

    Sample response:

    Scenario 3: A new request to submit the report when ReportName parameter is ignored

    Sample request:

    Sample response:

    Scenario 4: A new request to submit the report when one of the dates parameter is ignored

    Sample request:

    Sample response:

  2. Call the ReportStatus API to get the status of the Reviewer Assessment Metrics Async API report. See Report Status API.

  3. Once the report is ready, call the Reviewer Assessment Metrics API to retrieve the report data from the asynchronous API. See Reviewer Assessment Metrics API.