Skip to content
Search! & Match! API

Activity Reporting🔗

Search! can provide reporting on the usage per environment by logging various events to an ElasticSearch database. These events will be recorded when processing requests on the server as well as through periodic usage statistics being sent from the front-end. The event logs are retained for 24 calendar months.

In the following sections we will describe both the events being logged and the export API for retrieving the raw data.

The reporting dashboard can be accessed directly via the link shown on the Search UI when you have the proper access. Access to the reporting dashboard is granted via the reportingAccess permission on the access token. It also requires a functional identitiesRequest configuration to map user/role ID's to names (in Users/Roles input autocomplete and User Activity table). Without a proper setup of the Identities Request Service, only user ID's will be shown.