Veritas™ Surveillance User Guide
- Introducing Veritas Surveillance
- About Veritas Surveillance
- Key features of Veritas Surveillance
- Feature comparison: Compliance Accelerator desktop client Vs Veritas Surveillance web client
- Sampling support for content sources
- About Veritas Surveillance system security
- Veritas Surveillance multi-tier architecture
- System requirements
- Getting started
- Working with dashboard widgets
- Managing employees and 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
- Closing or opening the departments for monitoring
- Deleting departments
- Managing department users
- Managing department-level archives
- Managing department-level searches
- About department-level searches
- Guidelines for effective searches
- Creating and running department-level searches
- Pausing and resuming searches
- Downloading search details for archives
- Disabling scheduled searches
- Previewing search results
- Accepting search results
- Rejecting a search result
- Resubmitting a search
- Managing department-specific hotword sets
- Managing department-specific labels
- 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 Veritas Surveillances to users (employees) and employee groups
- Restricting users to use hotwords in searches
- Removing a user role
- Managing application-level archives
- Managing application-level searches
- Managing application-specific hotword sets
- Managing application-specific labels
- Managing application-specific review comments
- Managing search schedules
- Managing export operations
- Managing reviews
- About reviewing with Veritas Surveillance
- Understanding the Review page
- Rearranging columns in the item list pane
- Changing the Preview pane position
- Filtering the items in the Review pane
- Reviewing the Audio-Video Transcript type items
- Reviewing searched items
- Viewing Intelligent Review Details
- Adding or removing text for machine learning
- Assigning review status to items
- Viewing hotwords highlighting
- Viewing hotwords in collaboration message
- Viewing tags highlighting
- Viewing tags in collaboration message
- Viewing the full content in a new window
- Adding comments to items
- Escalating the review items
- Viewing history of items
- Printing and downloading the items and attachments
- Working with reports
- About Veritas Surveillance reports
- Accessing data through the Microsoft SQL Server Reporting Services (SSRS)
- Enhanced reporting
- Configuring a reporting endpoint
- Authentication
- Departments API
- Roles API
- Users API
- UserRoles API
- ItemMetrics API
- ReviewerMapping API
- MonitoredEmployees API
- Evidence Of Review Async API
- Evidence of Review API
- Report Status API
- Supported OData query options
- Supported reporting endpoint API filters and their values
- Responses
- Managing Power BI templates for reporting APIs
- Configuring Microsoft Power BI Templates for Reporting APIs
- Accessing Veritas Surveillance reports and datasets through the OData web service
- Guidelines for using Veritas Surveillance templates with Microsoft Power BI Desktop
- TEMPLATE - Item Metrics
- TEMPLATE - Reviewer Mapping
- TEMPLATE- Evidence Of Review - Submit report request
- TEMPLATE- Evidence Of Review - View report data
- Saving, editing, and refreshing the Power BI reports
- Managing Audit Settings
- Working with Audit viewer
ItemMetrics - List by filter
POST https://<Reporting endpoint Base URL>/odata/ItemMetrics
The following filters can be used with the ItemMetrics API when invoked using the POST method. The system uses the operator between the filters to return the result based on the specified filters.
Name | Type | Description |
|---|---|---|
Departments | Optional | Specifies the department 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, the ItemMetrics API can pass maximum of 1000 Departments IDs. |
CaptureTypes | Optional | Specifies the mode/technique used to capture the item in Veritas Surveillance and returns item counts for items with the specified capture type. : JSON array of integers 'id'(identifier fields) that is CaptureTypes IDs. : As an input, the ItemMetrics API can pass maximum 10 CaptureTypes IDs. |
CaptureDateStart | Mandatory | Specifies the date on which items are captured or ingested in Veritas Surveillance is recorded as the CaptureDate for that item. Returns item counts whose CaptureDate is greater than or equal to the specified CaptureDateStart. : Date in the YYYY-MM-DD format that is CaptureDateStart. |
CaptureDateEnd | Mandatory | Specifies the date on which items are captured or ingested in Veritas Surveillance is recorded as the CaptureDate for that item. Returns item counts whose CaptureDate is less than or equal to the specified CaptureDateEnd. : Date in the YYYY-MM-DD format that is CaptureDateEnd. |
MessageDirections | Optional | Specifies whether the item was sent/received from within the organization or from an external source and returns item counts for items that have the specified message direction. : JSON array of integers 'id'(identifier fields) that is MessageDirections IDs : As an input, the ItemMetrics API can pass maximum 5 MessageDirections IDs. |
MessageTypes | Optional | Specifies the type of captured items and returns item counts for items that have the specified message type. : JSON array of integers 'id'(identifier fields) that is MessageTypes IDs. : As an input, the ItemMetrics API can pass maximum 100 MessageTypes IDs on a single page. |
To get the item counts for Departments ID 11154, between CaptureDateStart 2023-11-24 and CaptureDateEnd2023-10-24 and having CaptureType as 1 or 3.
To get item counts for Department IDs 9 and 5, between CaptureDateStart 2023-06-01 and CaptureDateEnd 2023-08-02 and having MessageTypes as 7 or 8.
POST https://<Reporting endpoint Base URL>/odata/ItemMetrics
{
"CaptureDateStart": "2023-06-01",
"CaptureDateEnd": "2023-08-02",
"Departments": [9,5],
"MessageTypes": [7,8]
}
To get item counts for Departments IDs 9 and 5 , between CaptureDateStart 2023-06-01 and CaptureDateEnd 2023-08-02 and having MessageDirections as 1 or 2.
POST https://<Reporting endpoint Base URL>/odata/ItemMetrics
{
"CaptureDateStart": "2023-06-01",
"CaptureDateEnd": "2023-08-02",
"Departments": [9,5],
"MessageDirections": [1,2]
}
To get item counts for Departments IDs 9 and 5, between CaptureDateStart 2023-06-01 and CaptureDateEnd 2023-08-02 and having MessageTypes as 7 or 8.
POST https://<Reporting endpoint Base URL>/odata/ItemMetrics
{
"CaptureDateStart": "2023-06-01",
"CaptureDateEnd": "2023-06-02",
"Departments": [9,5],
"MessageTypes": [7,8]
}
Status code: 200 OK
See Supported OData query options.
See Responses.