Enterprise Vault™ Insight Surveillance Reviewer's Guide
- Introducing Insight Surveillance
- Searching for items
- Manually reviewing items
- About reviewing with Insight Surveillance
- About the Review pane
- Viewing the hotword statistics for an item in review
- Filtering the items in the Review pane
- Assigning review marks to items
- Adding comments to items
- Viewing the history of items
- Displaying printable versions of items
- Downloading the original versions of items
- Copying the item list to the Clipboard
- Escalating items
- Changing how the Review pane looks
- Setting your Review pane preferences
- Working with research folders
- About research folders
- Creating research folders
- Editing the properties of research folders
- Copying items to research folders
- Reviewing the items in research folders
- Exporting items from research folders
- Giving other users access to your research folders
- Committing research folder items to the department review set
- Removing items from research folders
- Deleting folders
- Exporting items
- Creating and viewing reports
- About the Insight Surveillance reports
- Accessing data through the Microsoft SQL Server Reporting Services (SSRS)
- Enhanced reporting
- Accessing reports through the OData web service
- Configuring a Power BI template for reporting
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. |
CaptureType | Optional | Specifies the mode/technique used to capture the item in Insight Surveillance and returns item counts for items with the specified capture type. : JSON array of integers 'id'(identifier fields) that is CaptureType IDs. : As an input, the ItemMetrics API can pass maximum 10 CaptureType IDs. |
CaptureDateStart | Mandatory | Specifies the date on which items are captured or ingested in Insight Surveillance is recorded as the CaptureDate for that item. Returns item counts whose CaptureDate is greater than or equal to the specified CaptureDateStart. : yyyy-mm-dd : JSON array of integers 'id'(identifier fields) that is CaptureDateStart. |
CaptureDateEnd | Mandatory | Specifies the date on which items are captured or ingested in Insight Surveillance is recorded as the CaptureDate for that item. Returns item counts whose CaptureDate is less than or equal to the specified CaptureDateEnd. : yyyy-mm-dd : JSON array of integers 'id'(identifier fields) 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. |
MessageType | 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 MessageType IDs. : As an input, the ItemMetrics API can pass maximum 100 MessageType IDs on a single page. |
To get the item counts for Departments IDs 7622, between CaptureDates 2023-11-24 and 2023-12-24 and having CaptureType as 1 or 3.
POST https://<Reporting endpoint Base URL>/odata/ItemMetrics
{
{"CaptureDateStart": "2023-11-24",
"CaptureDateEnd": "2023-12-24",
"Departments": [7622],
"CaptureType": [1,3]
}
Status code: 200 OK
To get item counts for Department IDs 9 and 5, between CaptureDates 2023-06-01 and 2023-08-02 and having MessageType IDs as 7 or 8.
POST https://<Reporting endpoint Base URL>/odata/ItemMetrics
{
"CaptureDateStart": "2023-06-01",
"CaptureDateEnd": "2023-08-02",
"Departments": [9,5],
"MessageType": [7,8]
}
To get item counts for Departments IDs 9 and 5 , between CaptureDates 2023-06-01 and 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 CaptureDates 2023-06-01 and 2023-08-02 and having MessageType IDs as 7 or 8.
POST https://<Reporting endpoint Base URL>/odata/ItemMetrics
{
"CaptureDateStart": "2023-06-01",
"CaptureDateEnd": "2023-06-02",
"Departments": [9,5],
"MessageType": [7,8]
}
See Supported OData query options.
See Supported reporting endpoint API filters and their values.
See Responses.