Item Hotword Metrics API

• Overview
• General workflow
• Submit Report Endpoint (asynchronous)
• View Report Endpoint (synchronous)
• Sample reference reports

Overview

General workflow

1. Request Setup: You provide a report name, start date, and end date (mandatory). Optionally, You can filter by departments.
2. Item Collection: The system gathers all items captured within that date range, scoped to the chosen departments.
3. Hotword Counting: For each item, it counts how many times hotwords appear, grouped by hotword and by category.
4. Review Status Categorization: Each hotword hit is further classified by its review status (e.g., Relevant, Irrelevant, Unreviewed).
5. Report Generation: A snapshot of the report is created asynchronously. You check progress via the ReportStatus API.
6. Output Retrieval: Final results — hotword counts with review status breakdown per department and category — are accessed through the ItemHotwordMetrics API.

Submit Report Endpoint (asynchronous)

1. Call the ItemHotwordMetricsAsync 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/ItemHotwordMetricsAsync?ReportName=<Name of the report>&StartDate=<YYYY-MM-DD>&EndDate=<YYYY-MM-DD>
   • POST https://<Reporting endpoint base URL>/OData/ItemHotwordMetricsAsync
   Sample Input
   • GET https://<Reporting endpoint Base URL>/odata/ ItemHotwordMetricsAsync?ReportName=<Name of the report>&StartDate= <YYYY-MM-DD>&EndDate=<YYYY-MM-DD>&Departments=[<DeptID1>,<DeptID2>,...]
   • POST https://<Reporting endpoint base URL>/OData/ItemHotwordMetricsAsync
   Parameter/Filters
   The following parameters/filters can be used with the ItemHotwordMetricsAsync 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.

   Parameter	Required	Description
   ReportName	Mandatory	Specify the name of the report you want to generate.
   		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 date items are captured or ingested in Arctera Surveillance and recorded as their capture date.
   		Specify the start date to return the count of items with a capture date on or after this date.
   		Data Type
   		Date in the YYYY-MM-DD format that is StartDate.
   		Limitations
   EndDate	Mandatory	Specify the end date to return the count of items with a capture date on or before this date.
   		Data Type
   		Date in the YYYY-MM-DD format that is StartDate.
   		Limitations
   Departments	Optional	Specifies the departments to which the captured 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.

   Scenario 1: New request to submit a report
   Sample input:
   
   Sample 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 Hotword 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:
   
2. Call the ReportStatus API to get the status of the ItemHotwordMetricsAsync API report. See Report Status API.
3. Once the report is ready, call the ItemHotwordMetrics synchronous API to retrieve the report data from the asynchronous API.

View Report Endpoint (synchronous)

• Item Counts by hotwords: Displays the number of items each hotword has been applied to in the department.
• Capture Information: Displays the capture date along with counts for various marking statuses.
• Hotword Details: Displays additional information about hotwords, including the hotword name, hotword category IDs, and the hotword category name.

• GET https://<Reporting endpoint Base URL>/odata/ItemHotwordMetrics?reportid=<ID of the ItemHotwordMetricsAsync API report>
• GET https://<Reporting endpoint Base URL>/odata/ItemHotwordMetrics?reportid=d0558287-3349-4df3-9528-11168637a83b

Sample reference reports