The EUM Server has different endpoints serving distinct functions. This page provides a reference for testing the health and getting information about on-prem EUM Servers.

The endpoints include the following:

  • EUM API - acts as the interface between the EUM Server and the Controller. The Controller retrieves EUM data from the EUM Server through the EUM API endpoint.
  • EUM Collector - collects metrics from the EUM agents. The JavaScript Agent and Mobile Agents transmit data to the EUM Server through the EUM Collector endpoint.
  • EUM Aggregator - collects and rolls up all the metrics per application and provide an interface for Controllers to download the metrics by application and timestamp. 
  • Screenshot Service - collects and serves image tiles that form mobile screenshots. The Mobile Agents transmit the tiles to the Screenshot Service, and the Controller retrieves the tiles to display the screenshots in mobile sessions.

EUM Server Endpoint URLs

The table below lists the endpoints, the default URL, and the supported paths.

EUM Server EndpointDefault URLPaths / Description
EUM APIhttp(s)://<domain-name>:7001/v2
/current-timeReturns the current time of the EUM Server as a Unix timestamp.
/pingReturns whether the EUM Server is running.
/sessionReturns whether your EUM Server supports sessions.
/versionReturns the version, build, and commit, and timestamp of the EUM Processor.
EUM Collectorhttp(s)://<domain-name>:7001/eumcollector
/adrum.gifReceives image beacons from the JavaScript Agent.
/beacons/browserEarliest endpoint for receiving CORS beacons from the JavaScript Agent.
/beacons/browser/v1/*The V1 endpoint for receiving CORS beacons from the JavaScript Agent.
/beacons/browser/v2/*The V2 and latest endpoint for receiving CORS beacons from the JavaScript Agent.
/get-versionReturns the version, build, and commit, and timestamp of the EUM Processor.
/iot/v1/application/*The endpoint for IoT REST APIs. See the IoT REST API reference documentation for details.
/pingReturns whether the EUM Collector is accessible and running.
/mobileMetrics?version=2The endpoint used by the Mobile Agents to send mobile beacons via HTTP POST.
/whoamiReturns the IP address, geo location, and information of the client making the request.
EUM Aggregatorhttp(s)://<domain-name>:7001/eumaggregator
/currentTimeReturns the current time of the EUM Aggregator as a Unix timestamp.
/get-versionReturns the version, build, and commit, and timestamp of the EUM Processor.
/pingReturns whether the EUM Aggregator is accessible and running.
Screenshot Servicehttp(s)://<domain-name>:7001/screenshots/v1
/versionReturns the version, build, commit, and timestamp of the Screenshot Service.

 

 

  • No labels