Skip to main content

March 14, 2026

Monitor Session Statistics API

The parameters listed here describe the session statistics captured at the last monitoring interval.

URL call: https://<UAGIP>:9443/rest/v1/monitor/stats

Generic Status and Stats

AttributeDescription
dateIndicates the date of statistics collected in the timezone of Unified Access Gateway appliance.
uagVersionIndicates the current version of the Unified Access Gateway applicance running on the user's environment.
uptimeInMinsIndicates the time (in minutes) that Unified Access Gateway appliance is up and running.
authenticatedSessionCountIndicates the overall count of authenticated sessions.
sessionCountIndicates the overall count of the sessions.

Horizon View

AttributeDescription
totalSessionsIndicates the sum of active and inactive sessions.
Admin UI: Total Sessions
highWaterMarkOfSessionsIndicates the maximum number of concurrent sessions at a given point in time.
Admin UI: Session High Water Mark
authenticatedSessionsIndicates the number of ongoing authenticated sessions (logged in sessions).
Admin UI: Active (Logged In) Sessions
unauthenticatedSessionsIndicates the number of unauthenticated sessions.
Admin UI: Inactive Sessions
failedLoginAttemptsIndicates the number of failed login attempts.
Admin UI: Failed Login Attempts
userCountIndicates the number of unique users currently authenticated.
BLAST
sessionsIndicates the number of active BLAST sessions.
maxSessionsIndicates the number of authorized BLAST sessions.
PCoIP
sessionsIndicates the number of active PCoIP sessions created during the start of a desktop or an application.
maxSessionsIndicates the maximum number of concurrent PCoIP sessions at a given point in time.
Tunnel
sessionsIndicates the number of active Tunnel sessions created on authentication through View Client.
maxSessionsIndicates the maximum number of concurrent Tunnel sessions at a given point in time.

Web Reverse Proxy

AttributeDescription
totalSessionsIndicates the sum of active and inactive sessions.
Admin UI: Total Sessions
highWaterMarkOfSessionsIndicates the maximum number of concurrent sessions at a given point in time.
Admin UI: Session High Water Mark
authenticatedSessionsIndicates the number of ongoing authenticated sessions (logged in sessions).
Admin UI: Active (Logged In) Sessions
unauthenticatedSessionsIndicates the number of unauthenticated sessions.
Admin UI: Inactive Sessions
failedLoginAttemptsIndicates the number of failed login attempts.
Admin UI: Failed Login Attempts
userCountIndicates the number of unique users currently authenticated.
backendStatus
statusIndicates if the back-end application is reachable. (Running, Not Reachable)
reasonIndicates and explains the status with reason. (Reachable, Error details)
kcdStatus
statusIndicates if the kcd server is reachable. (Running, Not Reachable)
reasonIndicates and explains the status with reason. (Reachable, Error details)

Tunnel

AttributeDescription
identifierIndicates that the Tunnel service is enabled.
statusStatus of the Tunnel service (vpnd service).
reasonIndicates and explains the status with reason for the Tunnel service. Up or Down labels denote the service status.
totalSessionsIndicates the number of active Tunnel sessions created on authentication through the Tunnel client.
connectionsIndicates the number of active outbound connections from the Tunnel Tunnel Server.
upTimeIndicates the active (running) time of the Tunnel service.
apiConnectivityTunnel Server to the API connectivity. For example, True or False.
awcmConnectivityTunnel Server to the AWCM connectivity. For example, True or False.
cascadeModeProvides cascade information. For example, Off for Basic mode and front-end or back-end for a cascade setup.

Unified Access Gateway Appliance

AttributeDescription
cpuCoresIndicates the number of processor cores assigned to the appliance.
totalCpuLoadPercentIndicates the CPU load in percentage.
totalMemoryMbIndicates the total memory in megabytes.
freeMemoryMbIndicates the available unused memory in megabytes.
cpuDetailedStatsProvides the detailed statistics of the CPU used:
- idle: CPU does not perform any task.
- ioWait: CPU waits for the disk input/output operations to complete.
- irq: CPU allocated to hardware interrupts.
- nice: CPU used to allocate multiple processes that demand more cycles than the CPU can provide.
- softIrq: CPU services the soft interrupts.
- steal: Xen hypervisor allocates cycles to other tasks.
- system: CPU used by the operating system.
- user: CPU used by the user applications.
usedDiskSpacePercentageIndicates the disk usage in percentage.

Was this page helpful?

Provide feedback for this topic

Was this topic helpful?

Please do not include any personal or confidential information.

Generating link…