Get Display Protocol Performance Info

At least one of the listed privileges is required -

Privileges	Description
MACHINE_VIEW	Caller should have permission to this privilege, to perform this operation.
POOL_VIEW	Caller should have permission to this privilege, to perform this operation.
FEDERATED_SESSIONS_VIEW	Caller should have permission to this privilege, to perform this operation.

Request

URI

GET

https://{api_host}/rest/helpdesk/v1/performance/display-protocol

COPY

Query Parameters

string

session_id

Required

ID of the session, also applicable for global sessions.

session_id example

aa36240c-a7f4-3a00-9e3d-e71e2df1cc1b

string

pod_id

Optional

ID of the pod that hosted the session. Applicable for global sessions only

pod_id example

105717a7-eb8c-490e-90c4-8bfeb0e43d7e

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns DisplayProtocolPerformanceInfo of type(s) */*

{
    "blast_performance_data": {
        "audio_bytes_received": 1652079610000,
        "audio_bytes_transmitted": 1652079610000,
        "cdr_bytes_received": 1652079610000,
        "cdr_bytes_transmitted": 1652079610000,
        "imaging_bytes_received": 1652079610000,
        "imaging_bytes_transmitted": 1652079610000,
        "imaging_encoder_type": "test",
        "imaging_frames_per_second": 1652079610000,
        "session_bandwidth_uplink": 3872079619320,
        "session_bytes_transmitted": 1652079610000,
        "session_packet_loss_uplink": 1652079610000,
        "session_round_trip_time": 1652079610000
    },
    "pcoip_performance_data": {
        "audio_bytes_received": 1652079610000,
        "audio_bytes_sent": 1652079610000,
        "audio_rx_bandwidth": 1652079610000,
        "audio_tx_bandwidth": 1652079610000,
        "audio_tx_bandwidth_limit": 1652079610000,
        "general_bytes_received": 3872079619320,
        "general_bytes_sent": 1652079610000,
        "general_duration_seconds": 1652079610000,
        "general_packets_received": 1652079610000,
        "general_packets_sent": 1652079610000,
        "general_rx_packets_lost": 1652079610000,
        "general_tx_packets_lost": 1652079610000,
        "imaging_active_minimum_quality": 1652079610000,
        "imaging_apex2800_offload": 1652079610000,
        "imaging_bytes_received": 1652079610000,
        "imaging_bytes_sent": 3872079619320,
        "imaging_decoder_capability": 1652079610000,
        "imaging_encoded_frames": 1652079610000,
        "imaging_megapixel": 1652079610000,
        "imaging_negative_acknowledgements": 1652079610000,
        "imaging_rx_bandwidth": 1652079610000,
        "imaging_svga_dev_tap_frames": 1652079610000,
        "imaging_tx_bandwidth": 1652079610000,
        "network_round_trip_latency": 1652079610000,
        "network_rx_bandwidth": 1652079610000,
        "network_rx_bandwidth_peak": 1652079610000,
        "network_rx_packet_loss": 1652079610000,
        "network_tx_bandwidth": 1652079610000,
        "network_tx_bandwidth_active_limit": 1652079610000,
        "network_tx_bandwidth_limit": 3872079619320,
        "network_tx_packet_loss": 1652079610000,
        "usb_bytes_received": 1652079610000,
        "usb_bytes_sent": 1652079610000,
        "usb_rx_bandwidth": 1652079610000,
        "usb_tx_bandwidth": 1652079610000
    }
}

BlastPerformanceData

blast_performance_data

Optional

blast_performance_data

PcoipPerformanceData

pcoip_performance_data

Optional

pcoip_performance_data

401

User is not authenticated

Operation doesn't return any data structure

403