action zoom_dashboard_webinar_participant_qos {
  label: "Get webinar participant QoS"
  description: "Retrieve details on the quality of service that participants from live or past webinars recieved.<br>This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.<br>\n**Scopes:** `dashboard_webinars:read:admin`<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` <br>\n**Prerequisites:** <br>\n* Business, Education or API Plan with Zoom Rooms set up.\n"
  provider: zoom
  method: GET
  path: "/metrics/webinars/{webinarId}/participants/{participantId}/qos"
  encoding: json
  input: {
    type: "object"
    properties: {
      participantId: {
        type: "string"
      }
      type: {
        type: "string"
        enum: ["past", "live"]
      }
      webinarId: {
        type: "string"
      }
    }
    required: ["participantId", "webinarId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Participant QOS."
    properties: {
      device: {
        type: "string"
        description: "The type of device using which the participant joined the meeting."
      }
      domain: {
        type: "string"
        description: "Participant's PC domain."
      }
      harddisk_id: {
        type: "string"
        description: "Participant's hard disk ID."
      }
      ip_address: {
        type: "string"
        description: "Participant's IP address."
      }
      join_time: {
        type: "string"
        format: "date-time"
        description: "The time at which participant joined the meeting."
      }
      leave_time: {
        type: "string"
        format: "date-time"
        description: "The time at which participant left the meeting."
      }
      location: {
        type: "string"
        description: "Participant's location."
      }
      mac_addr: {
        type: "string"
        description: "Participant's MAC address."
      }
      pc_name: {
        type: "string"
        description: "Participant's PC name."
      }
      user_id: {
        type: "string"
        format: "uuid"
        description: "Participant ID."
      }
      user_name: {
        type: "string"
        description: "Participant display name."
      }
      user_qos: {
        type: "array"
        description: "Quality of service provided to the user."
        items: {
          type: "object"
          properties: {
            as_device_from_crc: {
              type: "object"
              description: "QoS metrics on screen shares by a participant who joined the meeting via a Cloud Room Connector."
              properties: {
                avg_loss: {
                  type: "string"
                  description: "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination. "
                }
                bitrate: {
                  type: "string"
                  description: "The number of bits per second that can be transmitted along a digital network. The value of this field is expressed in kbps."
                }
                jitter: {
                  type: "string"
                  description: "The variation in the delay of received packets. The value of this field is expressed in milliseconds. "
                }
                latency: {
                  type: "string"
                  description: "The amount of time it takes for a packet to travel from one point to another. The value of this field is expressed in milliseconds. "
                }
                max_loss: {
                  type: "string"
                  description: "The max amount of packet loss, that is the max percentage of packets that fail to arrive at their destination."
                }
              }
            }
            as_device_to_crc: {
              type: "object"
              description: "QoS metrics on screen shares output being received by a participant who joined the meeting via a Cloud Room Connector."
              properties: {
                avg_loss: {
                  type: "string"
                  description: "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination. "
                }
                bitrate: {
                  type: "string"
                  description: "The number of bits per second that can be transmitted along a digital network. The value of this field is expressed in kbps."
                }
                jitter: {
                  type: "string"
                  description: "The variation in the delay of received packets. The value of this field is expressed in milliseconds. "
                }
                latency: {
                  type: "string"
                  description: "The amount of time it takes for a packet to travel from one point to another. The value of this field is expressed in milliseconds. "
                }
                max_loss: {
                  type: "string"
                  description: "The max amount of packet loss, that is the max percentage of packets that fail to arrive at their destination."
                }
              }
            }
            as_input: {
              type: "object"
              description: "Quality of service object."
            }
            as_output: {
              type: "object"
              description: "Quality of service object."
            }
            audio_device_from_crc: {
              type: "object"
              description: "QoS metrics on audio being sent by a participant who joined the meeting via a Cloud Room Connector."
              properties: {
                avg_loss: {
                  type: "string"
                  description: "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination. "
                }
                bitrate: {
                  type: "string"
                  description: "The number of bits per second that can be transmitted along a digital network. The value of this field is expressed in kbps."
                }
                jitter: {
                  type: "string"
                  description: "The variation in the delay of received packets. The value of this field is expressed in milliseconds. "
                }
                latency: {
                  type: "string"
                  description: "The amount of time it takes for a packet to travel from one point to another. The value of this field is expressed in milliseconds. "
                }
                max_loss: {
                  type: "string"
                  description: "The max amount of packet loss, that is the max percentage of packets that fail to arrive at their destination."
                }
              }
            }
            audio_device_to_crc: {
              type: "object"
              description: "QoS metrics on audio received by a participant who joined the meeting via a Cloud Room Connector."
              properties: {
                avg_loss: {
                  type: "string"
                  description: "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination. "
                }
                bitrate: {
                  type: "string"
                  description: "The number of bits per second that can be transmitted along a digital network. The value of this field is expressed in kbps."
                }
                jitter: {
                  type: "string"
                  description: "The variation in the delay of received packets. The value of this field is expressed in milliseconds. "
                }
                latency: {
                  type: "string"
                  description: "The amount of time it takes for a packet to travel from one point to another. The value of this field is expressed in milliseconds. "
                }
                max_loss: {
                  type: "string"
                  description: "The max amount of packet loss, that is the max percentage of packets that fail to arrive at their destination."
                }
              }
            }
            audio_input: {
              type: "object"
              description: "Quality of Service object."
              properties: {
                avg_loss: {
                  type: "string"
                  description: "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination. "
                }
                bitrate: {
                  type: "string"
                  description: "The number of bits per second that can be transmitted along a digital network. The value of this field is expressed in kbps."
                }
                jitter: {
                  type: "string"
                  description: "The variation in the delay of received packets. The value of this field is expressed in milliseconds. "
                }
                latency: {
                  type: "string"
                  description: "The amount of time it takes for a packet to travel from one point to another. The value of this field is expressed in milliseconds. "
                }
                max_loss: {
                  type: "string"
                  description: "Max loss: the max amount of packet loss, that is the max percentage of packets that fail to arrive at their destination."
                }
              }
            }
            audio_output: {
              type: "object"
              description: "Quality of Service object."
              properties: {
                avg_loss: {
                  type: "string"
                  description: "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination. "
                }
                bitrate: {
                  type: "string"
                  description: "The number of bits per second that can be transmitted along a digital network. The value of this field is expressed in kbps."
                }
                jitter: {
                  type: "string"
                  description: "The variation in the delay of received packets. The value of this field is expressed in milliseconds. "
                }
                latency: {
                  type: "string"
                  description: "The amount of time it takes for a packet to travel from one point to another. The value of this field is expressed in milliseconds. "
                }
                max_loss: {
                  type: "string"
                  description: "Max loss: the max amount of packet loss, that is the max percentage of packets that fail to arrive at their destination."
                }
              }
            }
            cpu_usage: {
              type: "object"
              properties: {
                system_max_cpu_usage: {
                  type: "string"
                  description: "System Maximum CPU Usage"
                }
                zoom_avg_cpu_usage: {
                  type: "string"
                  description: "Zoom Average CPU Usage"
                }
                zoom_max_cpu_usage: {
                  type: "string"
                  description: "Zoom Maximum CPU Usage"
                }
                zoom_min_cpu_usage: {
                  type: "string"
                  description: "Zoom Minimum CPU Usage"
                }
              }
            }
            date_time: {
              type: "string"
              format: "date-time"
              description: "Date-time of QOS"
            }
            video_device_from_crc: {
              type: "object"
              description: "QoS metrics on video input being sent from a Cloud Room Connector used by the participant to join the meeting."
              properties: {
                avg_loss: {
                  type: "string"
                  description: "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination. "
                }
                bitrate: {
                  type: "string"
                  description: "The number of bits per second that can be transmitted along a digital network. The value of this field is expressed in kbps."
                }
                jitter: {
                  type: "string"
                  description: "The variation in the delay of received packets. The value of this field is expressed in milliseconds. "
                }
                latency: {
                  type: "string"
                  description: "The amount of time it takes for a packet to travel from one point to another. The value of this field is expressed in milliseconds. "
                }
                max_loss: {
                  type: "string"
                  description: "The max amount of packet loss, that is the max percentage of packets that fail to arrive at their destination."
                }
              }
            }
            video_device_to_crc: {
              type: "object"
              description: "QoS metrics on video output received by a participant who joined the meeting via a Cloud Room Connector."
              properties: {
                avg_loss: {
                  type: "string"
                  description: "The average amount of packet loss, i.e., the percentage of packets that fail to arrive at their destination. "
                }
                bitrate: {
                  type: "string"
                  description: "The number of bits per second that can be transmitted along a digital network. The value of this field is expressed in kbps."
                }
                jitter: {
                  type: "string"
                  description: "The variation in the delay of received packets. The value of this field is expressed in milliseconds. "
                }
                latency: {
                  type: "string"
                  description: "The amount of time it takes for a packet to travel from one point to another. The value of this field is expressed in milliseconds. "
                }
                max_loss: {
                  type: "string"
                  description: "The max amount of packet loss, that is the max percentage of packets that fail to arrive at their destination."
                }
              }
            }
            video_input: {
              type: "object"
              description: "Quality of service object."
            }
            video_output: {
              type: "object"
              description: "Quality of service object."
            }
          }
        }
      }
      version: {
        type: "string"
        description: "Participant's Zoom Client version."
      }
    }
  }
}