Get Session Metrics

• Monitor

Gets summary of local session metrics.

Request

URI

GET

https://{api_host}/rest/monitor/v1/sessions/metrics

COPY

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Hide Details

OK

Returns SessionMetrics of type(s) */*

{
    "application_session_metrics": {
        "num_active_sessions": 0,
        "num_disconnected_sessions": 0,
        "num_idle_sessions": 0,
        "num_pending_sessions": 0
    },
    "client_metrics": {
        "num_android_clients": 0,
        "num_browser_clients": 0,
        "num_ios_clients": 0,
        "num_linux_clients": 0,
        "num_mac_clients": 0,
        "num_other_clients": 0,
        "num_windows_clients": 0
    },
    "desktop_session_metrics": {
        "num_active_sessions": 0,
        "num_disconnected_sessions": 0,
        "num_idle_sessions": 0,
        "num_pending_sessions": 0
    },
    "gateway_metrics": {
        "num_external_gateways": 0,
        "num_internal_gateways": 0,
        "num_unknown_gateways": 0
    },
    "num_sessions": 0,
    "num_users": 0,
    "protocol_metrics": {
        "num_blast_sessions": 0,
        "num_other_protocols": 0,
        "num_pcoip_sessions": 0,
        "num_rdp_sessions": 0
    },
    "rds_session_metrics": {
        "num_active_sessions": 0,
        "num_disconnected_sessions": 0,
        "num_idle_sessions": 0,
        "num_pending_sessions": 0
    }
}

SessionStateMetrics

application_session_metrics

Optional

application_session_metrics

SessionClientMetrics

client_metrics

Optional

client_metrics

SessionStateMetrics

desktop_session_metrics

Optional

desktop_session_metrics

SessionGatewayMetrics

gateway_metrics

Optional

gateway_metrics

integer As int32 As int32

num_sessions

Optional

The total number of sessions.

integer As int32 As int32

num_users

Optional

The total number of users.

SessionProtocolMetrics

protocol_metrics

Optional

protocol_metrics

SessionStateMetrics

rds_session_metrics

Optional

rds_session_metrics

401

Hide Details

User is not authenticated

Operation doesn't return any data structure

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

Monitor Operations

GET

Get App Volumes Manager Monitor Info

GET

Get App Volumes Manager Monitor Info V2

GET

Get Connection Server Monitor Info V2

GET

Get Connection Server Monitor Info V3

GET

Get Event Database Monitor

GET

Get Farm Monitor Info

GET

Get Gateway Monitor Info

GET

Get Gateway Monitor Info V2

GET

Get License Usage Metrics

GET

Get Message Client Monitor

GET

Get Pod Monitor Info V2

GET

Get Pod Session Metrics Info

GET

Get RDS Server Monitors

GET

Get SAML Authenticator Monitor Info

GET

Get Session Metrics

GET

Get System Metrics Info

GET

Get True SSO Monitor Info

GET

Get View Composer By VC Id

GET

Get Virtual Center Monitor Info

GET

Get Virtual Center Monitor Info V3

GET

List AD Domain Monitor Infos V2

GET

List AD Domain Monitor Infos V3

GET

List AD Domain Monitors

GET

List App Volumes Manager Monitor Info V1

GET

List App Volumes Manager Monitor Info V2

GET

List Connection Server Monitors

GET

List Connection Server Monitors V2

GET

List Connection Server Monitors V3

GET

List Desktop Pool Metrics

GET

List Desktop Pool Or Farm Datastore Usage Info

GET

List Farm Monitors

GET

List Gateway Monitor Info V1

GET

List Gateway Monitor Info V2

GET

List Gateway Monitor Info V3

GET

List Global Desktop Entitlements Metrics

GET

List Health Metrics Info

GET

List Message Clients Monitors

GET

List Pod Monitor Infos V1

GET

List Pod Monitor Infos V2

GET

List RDS Server Monitors

GET

List SAML Authenticator Monitors V1

GET

List SAML Authenticator Monitors V2

GET

List True SSO Monitor Infos

GET

List View Composer Monitors V1

GET

List View Composer Monitors V2

GET

List Virtual Center Monitors

GET

List Virtual Center Monitors V2

GET

List Virtual Center Monitors V3