Item Archived Metrics API

Last published : Oct 15, 2026
This topic provides information on the following:
Related information
Enhanced reporting - API

Overview

The Item Archived Metrics API generates reports that provide summary metrics for archived items in Arctera Surveillance. The report helps you analyze archived communication data based on the specified report parameters and filters. You can use this API to monitor archival trends, generate compliance reports, and integrate archived item metrics with external reporting and analytics tools. The API supports both synchronous and asynchronous execution methods.

Submit Report Endpoint (asynchronous)

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 ItemArchivedMetricsAsync API, follow the steps below:
  1. Call the ItemArchivedMetricsAsync API to submit a report generation request.
    GET https://<Reporting endpoint base URL>/OData/ItemArchivedMetricsAsync? IndexStartDate=<YYYY-MM-DD>&IndexEndDate=<YYYY-MM-DD>&ReportName=<Name of the report>
    Sample Input
    GET https://<Reporting endpoint base URL>/OData/ItemArchivedMetricsAsync? IndexStartDate=2024-01-01&IndexEndDate=2024-05-31&ReportName=TotalCountReport
    Parameter/Filters
    The following parameters/filters can be used with the ItemArchivedMetricsAsync API when invoked using the GET method. The system uses the AND operator between the filters to return the result based on the specified filters.
    Parameter Required Description
    ReportName Mandatory Specify the name of the report you want to generate.
    Limitations
    - The report name can be up to 256 characters long.
    - Special characters are not allowed; only alphanumeric values are permitted.
    IndexStartDate Mandatory IndexStartDate refers to the start date on which the items were archived.
    Specify the start date to return the count of items with an archive date on or after this date.
    Data Type
    Date in the YYYY-MM-DD format that specifies IndexStartDate.
    Limitations
    For the cloud-based application, a maximum duration of one year is allowed.
    IndexEndDate Mandatory IndexEndDate refers to the end date for the archived items to be included in the report.
    Specify the end date to return the count of items with an archive date on or before this date.
    Data Type
    Date in the YYYY-MM-DD format that specifies IndexEndDate.
    Limitations
    For the cloud-based application, a maximum duration of one year is allowed.
    Scenario 1: New request to submit a report
    Sample input:
    GET https://<Reporting endpoint base URL>/odata/ItemArchivedMetricsAsync? ReportName=TotalCountReport&IndexStartDate=2024-01-01& IndexEndDate=2024-05-31
    Sample response:
    image
    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 Archived 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 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: The same request has been submitted again within one minute
    Sample response:
    image
  2. Call the ReportStatus API to get the status of the ItemArchivedMetricsAsync API report. See Report Status API.
  3. Once the report is ready, call the ItemArchivedMetrics synchronous API to get the report data from the asynchronous API.

View Report Endpoint (synchronous)

This report provides the count of archived items, grouped by each MessageType, Employee, and Date.
Endpoint URL
GET https://<Reporting endpoint base URL>/odata/ItemArchivedMetrics
Sample requests
  • GET https://<Reporting endpoint Base URL>/odata/ItemArchivedMetrics?reportid=<ID of the ItemArchivedMetricsAsync API report>
  • GET https://<Reporting endpoint Base URL>/odata/ItemArchivedMetrics?reportid=accea85a-acd4-479c-acd8-0093d767aa4e
Parameter/Filters
The following filter can be used with the ItemArchivedMetrics API when invoked using the GET method only. The system uses the AND operator between the filters to return the result based on the specified filters.
Parameter Required Description
ReportID Mandatory Specify the ID of report you want to view.
Sample scenario
GET https://<Reporting endpoint base URL>/odata/ItemArchivedMetrics?ReportId=accea85a-acd4-479c-acd8-0093d767aa4e
Sample response:
Status code: 200 OK
image
Supported OData Filters
See Supported OData query options.
Responses
See Responses.