Skip to main content

July 28, 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 - accessPointStatusAndStats

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.
authenticatedViewSessionCountIndicates the number of ongoing authenticated Horizon View sessions (logged in sessions).
highWaterMarkIndicates the maximum number of concurrent sessions at a given point in time.
openIncomingConnectionCountIndicates the number of TCP connections opened with Unified Access Gateway.
overAllStatusIndicates the status of all Edge services combined.
timeStampIndicates the timestamp at which session stats was collected.

Consolidated Session Stats - accessPointStatusAndStats.edgeServiceSessionStats

AttributeDescription
identifierIndicates that the stats is for all Edge services (Total).
authenticatedSessionsIndicates the number of ongoing authenticated sessions (logged in sessions).
failedLoginAttemptsIndicates the number of failed login attempts.
highWaterMarkOfSessionsIndicates the maximum number of concurrent sessions at a given point in time.
totalSessionsIndicates the sum of active and inactive sessions.
unauthenticatedSessionsIndicates the number of unauthenticated sessions.
userCountIndicates the number of unique users currently authenticated.

Horizon View - accessPointStatusAndStats.viewEdgeServiceStats

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.
xmlapiUnrecognizedRequestsCountIndicates the number of unrecognized requests.
identifierIndicates the Edge Service name (VIEW).
statusIndicates the overall status Horizon View Edge Service.
BLAST - accessPointStatusAndStats.viewEdgeServiceStats.protocol name=blast
sessionsIndicates the number of active BLAST sessions.
maxSessionsIndicates the number of authorized BLAST sessions.
unrecognizedRequestsCountIndicates the number of unrecognized requests for BLAST.
PCoIP - accessPointStatusAndStats.viewEdgeServiceStats.protocol name=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.
unrecognizedRequestsCountIndicates the number of unrecognized requests for PCoIP.
Tunnel - accessPointStatusAndStats.viewEdgeServiceStats.protocol name=Tunnel,RDP
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.
unrecognizedRequestsCountIndicates the number of unrecognized requests for Tunnel.
backendStatus
statusIndicates if backend server is running (Running, Not Reachable).
reasonIndicates and explains the status with reason (Reachable, Error details).

Web Reverse Proxy - accessPointStatusAndStats.webReverseProxyStats

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. For example, it is reachable when the service is up and running, the Tunnel server is not reachable when the service is down.
totalSessionsIndicates the number of active Tunnel sessions created on authentication through the Tunnel client.
connectionsIndicates the number of active outbound connections from the Tunnel and 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 - accessPointStatusAndStats.applianceStats

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.
usedHeapSpacePercentageIndicates the heap usage in percentage.
cpuRunQueueIndicates the CPU run queue length (number of tasks running or waiting for run time).
memoryPageInRateIndicates the total number of kilobytes the system paged in from disk per second.
memoryPageOutRate Indicates the total number of kilobytes the system paged out to disk per second.
diskLatency Indicates the average time (in milliseconds) for I/O requests issued to the device to be served. This includes the time spent by the requests in queue and the time spent to service them.
diskQueueLengthIndicates the average queue length of the requests that were issued to the device.
vmToolsStatus Indicates the status of the VM Tools.
Note: The vmToolsStatus is applicable only for vSphere. For other platforms, vmToolsStatus is displayed as Unsupported hypervisor.
vmToolsVersionIndicates the version of VM Tools being used.
Note: The vmtoolsversion is applicable only for vSphere. Other platforms are displayed as unsupported-hypervisor.

Authentication - accessPointStatusAndStats.authentication

AttributeDescription
statusIndicates if EAS/CAS/Authbroker is running (Running, Not Reachable).
reasonIndicates and explains the status with reason (Reachable, Error details).
successLoginsIndicates the number of authenticated EAS/CAS/Authbroker sessions.
failedLoginsIndicates the number of failed login attempts.

Was this page helpful?

Provide feedback for this topic

Was this topic helpful?

Please do not include any personal or confidential information.

Generating link…