List session users QoS Summary

GET {{baseUrl}}/videosdk/sessions/:sessionId/users/qos_summary?page_size=1&next_page_token=<string>

Use this API to return a list of users from past sessions and a summary of their quality of service received during the session. The data returned indicates the connection quality for sending and receiving video, audio, and shared content.

Note:

This API may return empty values for users' name responses when the account calling this API: * Does not have a signed HIPAA business associate agreement (BAA). * Is a legacy HIPAA BAA account . * Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions.

Prerequisites:

  • A Business or a higher plan.
  • Developers must subscribe to the QSS summary event to receive data from this API.

Scopes: dashboard_meetings:read:admin

Rate Limit Label : Heavy

Request Params

| Key | Datatype | Required | Description | | page_size | number | | The number of items returned per page. | | next_page_token | string | | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |

HEADERS

| Key | Datatype | Required | Description | | Accept | string | | |

RESPONSES

status: OK

{&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;page_size&quot;:30,&quot;users&quot;:[{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;user_key&quot;:&quot;\u003cstring\u003e&quot;,&quot;qos&quot;:[{&quot;type&quot;:&quot;audio_device_from_crc&quot;,&quot;details&quot;:{&quot;min_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;resolution&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_min_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_avg_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_max_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;system_max_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;type&quot;:&quot;video_device_to_crc&quot;,&quot;details&quot;:{&quot;min_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;resolution&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_min_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_avg_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_max_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;system_max_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;}}]},{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;user_key&quot;:&quot;\u003cstring\u003e&quot;,&quot;qos&quot;:[{&quot;type&quot;:&quot;video_input&quot;,&quot;details&quot;:{&quot;min_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;resolution&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_min_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_avg_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_max_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;system_max_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;type&quot;:&quot;video_output&quot;,&quot;details&quot;:{&quot;min_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_bitrate&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_latency&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_jitter&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_loss&quot;:&quot;\u003cstring\u003e&quot;,&quot;resolution&quot;:&quot;\u003cstring\u003e&quot;,&quot;min_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;avg_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;max_frame_rate&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_min_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_avg_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;zoom_max_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;,&quot;system_max_cpu_usage&quot;:&quot;\u003cstring\u003e&quot;}}]}]}