Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

Get Meeting Qualities

Provides quality data for a meeting, by meetingId. Only organization administrators can retrieve meeting quality data.

GET/v1/meeting/qualities
Query Parameters
meetingId
stringrequired

Unique identifier for the specific meeting instance.

max
number

Limit the maximum number of media sessions in the response

Default: 100
offset
number

Offset from the first result that you want to fetch.

Default: 0
Response Properties
items
array
meetingId
string

5be9-4c25-b4b0-9b592c8a086b (string, required)

The meeting identifier for the specific meeting instance.

displayName
string

The display name of the participant of this media session.

email
string

The email address of the participant of this media session.

joined
string

The date and time when this participant joined the meeting.

client
string

The type of the client (and OS) used by this media session.

clientVersion
string

The version of the client used by this media session.

osType
string

The operating system used for the client.

osVersion
string

The version of the operating system used for the client.

hardwareType
string

The type of hardware used to attend the meeting

speakerName
string

A description of the speaker used in the meeting.

networkType
enum

The type of network.

wifi
cellular
ethernet
unknown
localIP
string

The local IP address of the client.

publicIP
string

The public IP address of the client.

camera
string

A description of the camera used in the meeting.

microphone
string

A description of the microphone used in the meeting.

serverRegion
string

The server region.

participantId
string

Used to identify the participant.

participantSessionId
string

Used to identify a specific session the participant has in a given meeting.

videoIn
array

The collection of downstream (sent to the client) video quality data.

samplingInterval
number

The sampling interval, in seconds, of the downstream video quality data.

startTime
string

The date and time when this video session started.

endTime
string

The date and time when this video session ended.

packetLoss
array

The percentage of video packet loss, in float between 0.0 and 100.0, during each sampling interval.

latency
array

The average latency, in milliseconds, during each sampling interval.

resolutionHeight
array

The pixel height of the incoming video.

frameRate
array

The frames per second of the incoming video.

mediaBitRate
array

The bit rate of the incoming video.

codec
string

The incoming video codec.

jitter
array

The incoming video jitter.

transportType
enum

The network protocol used for video transmission.

UDP
TCP
videoOut
array

The collection of upstream (sent from the client) video quality data.

samplingInterval
number

The sampling interval, in seconds, of the upstream video quality data.

startTime
string

The date and time when this video session started.

endTime
string

The date and time when this video session ended.

packetLoss
array

The percentage of video packet loss, in float between 0.0 and 100.0, during each sampling interval.

latency
array

The average latency, in milliseconds, during each sampling interval.

resolutionHeight
array

The pixel height of the outgoing video.

frameRate
array

The frames per second of the outgoing video.

mediaBitRate
array

The bit rate of the outgoing video.

codec
string

The outgoing video codec.

jitter
array

The outgoing video jitter.

transportType
enum

The network protocol used for video transmission.

UDP
TCP
audioIn
array

The collection of downstream (sent to the client) audio quality data.

samplingInterval
number

The sampling interval, in seconds, of the downstream audio quality data.

startTime
string

The date and time when this audio session started.

endTime
string

The date and time when this audio session ended.

packetLoss
array

The percentage of audio packet loss, in float between 0.0 and 100.0, during each sampling interval.

latency
array

The average latency, in milliseconds, during each sampling interval.

resolutionHeight
array

Not applicable to audio.

frameRate
array

Not applicable to audio.

mediaBitRate
array

The bitrate of the incoming audio.

codec
string

The codec of the incoming audio.

jitter
array

The incoming audio jitter.

transportType
enum

The network protocol used for video transmission.

UDP
TCP
audioOut
array

The collection of upstream (sent from the client) audio quality data.

samplingInterval
number

The sampling interval, in seconds, of the upstream audio quality data.

startTime
string

The date and time when this audio session started.

endTime
string

The date and time when this audio session ended.

packetLoss
array

The percentage of audio packet loss, in float between 0.0 and 100.0, during each sampling interval.

latency
array

The average latency, in milliseconds, during each sampling interval.

resolutionHeight
array

Not applicable to audio out.

frameRate
array

Not applicable to audio out.

mediaBitRate
array

The bit rate of the outgoing audio.

codec
string

The audio codec.

jitter
array

The outgoing audio jitter.

transportType
enum

The network protocol used for video transmission.

UDP
TCP
audioPSTN
array

PSTN quality data.

samplingInterval
number

The sampling interval, in seconds, of the PSTN audio quality data.

startTime
string

The date and time when this audio session started.

endTime
string

The date and time when this audio session ended.

meanOpinionScore
array

The mean opinion score (MOS) for the PSTN audio session.

shareIn
array

The collection of downstream (sent to the client) share quality data.

samplingInterval
number

The sampling interval, in seconds, of the downstream content sharing data.

startTime
string

The date and time when this content sharing session started.

endTime
string

The date and time when this content sharing session ended.

packetLoss
array

The percentage of content sharing packet loss, in float between 0.0 and 100.0, during each sampling interval.

latency
array

The average latency, in milliseconds, during each sampling interval.

resolutionHeight
array

The height in pixels of the incoming share video.

frameRate
array

The frame rate of the incoming share video.

mediaBitRate
array

The bit rate for the incoming share video.

codec
string

The codec for the incoming share video.

jitter
array

The jitter for the incoming share video.

transportType
enum

The network protocol used for video transmission.

UDP
TCP
shareOut
array

The collection of upstream (sent from the client) share quality data.

samplingInterval
number

The sampling interval, in seconds, of the upstream content sharing data.

startTime
string

The date and time when this content sharing session started.

endTime
string

The date and time when this content sharing session ended.

packetLoss
array

The percentage of content sharing packet loss, in float between 0.0 and 100.0, during each sampling interval.

latency
array

The average latency, in milliseconds, during each sampling interval.

resolutionHeight
array

The height in pixels of the outgoing share video.

frameRate
array

The frame rate of the outgoing share video.

mediaBitRate
array

The bit rate of the outgoing share video.

codec
string

The codec of the outgoing share video.

jitter
array

The jitter for the outgoing share video.

transportType
enum

The network protocol used for video transmission.

UDP
TCP
resources
array

Device resources such as CPU and memory.

processAverageCPU
array

The average percent CPU for the process.

processMaxCPU
array

The max percent CPU for the process.

systemAverageCPU
array

The average percent CPU for the system.

systemMaxCPU
array

The max percent CPU for the system.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/meeting/qualities{?meetingId,max,offset}
Log in to try the API.
Header
Query Parameters
  • Unique identifier for the specific meeting instance.
  • Limit the maximum number of media sessions in the response
  • Offset from the first result that you want to fetch.
https://analytics.webexapis.com/v1/meeting/qualities?meetingId=25bbf831-5be9-4c25-b4b0-9b592c8a086b&max=100&offset=0
200 / OK
{
  "items": [
    {
      "meetingId": "25bbf831",
      "displayName": "John Andersen",
      "email": "john.andersen@example.com",
      "joined": "2020-04-10T17:00:00.000Z",
      "client": "Teams_Mobile_Client (iOS)",
      "clientVersion": "40.5.0.210",
      "osType": "mac",
      "osVersion": "Version 10.14.6 (Build 18G3020)",
      "hardwareType": "mac book",
      "speakerName": "MacBook Pro Speakers",
      "networkType": "wifi",
      "localIP": "10.24.72.54",
      "publicIP": "10.24.72.54",
      "camera": "FaceTime HD Camera",
      "microphone": "External Microphone",
      "serverRegion": "San Jose, USA",
      "participantId": "8635cbf0ca1a4573b27348e560679b25_I_158174534545967299_57",
      "participantSessionId": "3324C9D0-9EA7-45A2-B249-5B62A384AFEF",
      "videoIn": [
        {
          "samplingInterval": 60,
          "startTime": "2020-04-10T17:00:00.000Z",
          "endTime": "2020-04-10T18:00:00.000Z",
          "packetLoss": [
            0.01,
            0.1,
            0.05
          ],
          "latency": [
            60,
            5,
            10
          ],
          "resolutionHeight": [
            90,
            90,
            90
          ],
          "frameRate": [
            25.940001,
            21.040001,
            18.84
          ],
          "mediaBitRate": [
            51880,
            74519,
            55285
          ],
          "codec": "H.264 BP",
          "jitter": [
            170,
            130,
            40
          ],
          "transportType": "UDP"
        }
      ],
      "videoOut": [
        {
          "samplingInterval": 60,
          "startTime": "2020-04-10T17:00:00.000Z",
          "endTime": "2020-04-10T18:00:00.000Z",
          "packetLoss": [
            0.01,
            0.1,
            0.05
          ],
          "latency": [
            60,
            5,
            10
          ],
          "resolutionHeight": [
            90,
            90,
            90
          ],
          "frameRate": [
            25.940001,
            21.040001,
            18.84
          ],
          "mediaBitRate": [
            51880,
            74519,
            55285
          ],
          "codec": "H.264 BP",
          "jitter": [
            4,
            6,
            4
          ],
          "transportType": "UDP"
        }
      ],
      "audioIn": [
        {
          "samplingInterval": 60,
          "startTime": "2020-04-10T17:00:00.000Z",
          "endTime": "2020-04-10T18:00:00.000Z",
          "packetLoss": [
            0.01,
            0.1,
            0.05
          ],
          "latency": [
            60,
            5,
            10
          ],
          "resolutionHeight": [
            90,
            90,
            90
          ],
          "frameRate": [
            25.940001,
            21.040001,
            18.84
          ],
          "mediaBitRate": [
            51880,
            74519,
            55285
          ],
          "codec": "Opus",
          "jitter": [
            4,
            6,
            4
          ],
          "transportType": "UDP"
        }
      ],
      "audioOut": [
        {
          "samplingInterval": 60,
          "startTime": "2020-04-10T17:00:00.000Z",
          "endTime": "2020-04-10T18:00:00.000Z",
          "packetLoss": [
            0.01,
            0.1,
            0.05
          ],
          "latency": [
            60,
            5,
            10
          ],
          "resolutionHeight": [
            90,
            90,
            90
          ],
          "frameRate": [
            25.940001,
            21.040001,
            18.84
          ],
          "mediaBitRate": [
            51880,
            74519,
            55285
          ],
          "codec": "Opus",
          "jitter": [
            4,
            6,
            4
          ],
          "transportType": "UDP"
        }
      ],
      "audioPSTN": [
        {
          "samplingInterval": 60,
          "startTime": "2020-04-10T17:00:00.000Z",
          "endTime": "2020-04-10T18:00:00.000Z",
          "meanOpinionScore": [
            1,
            2,
            3
          ]
        }
      ],
      "shareIn": [
        {
          "samplingInterval": 60,
          "startTime": "2020-04-10T17:00:00.000Z",
          "endTime": "2020-04-10T18:00:00.000Z",
          "packetLoss": [
            0.01,
            0.1,
            0.05
          ],
          "latency": [
            60,
            5,
            10
          ],
          "resolutionHeight": [
            90,
            90,
            90
          ],
          "frameRate": [
            25.940001,
            21.040001,
            18.84
          ],
          "mediaBitRate": [
            51880,
            74519,
            55285
          ],
          "codec": "H.264 BP",
          "jitter": [
            4,
            6,
            4
          ],
          "transportType": "UDP"
        }
      ],
      "shareOut": [
        {
          "samplingInterval": 60,
          "startTime": "2020-04-10T17:00:00.000Z",
          "endTime": "2020-04-10T18:00:00.000Z",
          "packetLoss": [
            0.01,
            0.1,
            0.05
          ],
          "latency": [
            60,
            5,
            10
          ],
          "resolutionHeight": [
            90,
            90
          ],
          "frameRate": [
            25.940001,
            21.040001,
            18.84
          ],
          "mediaBitRate": [
            51880,
            74519,
            55285
          ],
          "codec": "H.264 BP",
          "jitter": [
            4,
            6,
            4
          ],
          "transportType": "UDP"
        }
      ],
      "resources": [
        {
          "processAverageCPU": [
            "6",
            "8",
            "6"
          ],
          "processMaxCPU": [
            "14",
            "15",
            "14"
          ],
          "systemAverageCPU": [
            "19",
            "21",
            "18"
          ],
          "systemMaxCPU": [
            "27",
            "36",
            "30"
          ]
        }
      ]
    }
  ]
}