API enhancement to add consolidated QoS metrics

This is to request an enhance an existing API . enhancement is to return consolidated QoS metrics for meeting participants like it’s available when admin manually downloads the completed meetings QoS data. Below is the API i am referring to

API
[https://api.zoom.us/v2/metrics/meetings/{meetingId}/participants/{participantId}/qos]

/v2/metrics/meetings/{meetingId}/participants/qos?type=past&page_size=300&access_token=<access_token>

while i am happy that Zoom is providing metrics for each participant every min in API response. In addition to that, it would be nice if API can also provide a consolidated QoS metrics for each participant in a meeting. Please note that, when i manually download the QoS metrics data of complete meeting, i see a consolidated QoS metric values and not per min values. I am attaching manually downloaded Qos Metrics data for reference (this contains the consolidated QoS metrics for each user and not per min values). I expect similar data available using API as well.

Hence, i request to enhance the API so that consolidated QoS metrics are available in API response like it’s available when QoS metrics are manually downloaded

Hi @Dilip_Reddy_Guda,

Thanks for the request, we’ll reach out to the Engineers about this enhancement and see where we can fit this on our roadmap.

Thanks

Michael,

Thanks for the response. I would await for the updates from your engineering team on this. we believe this enhancement will help a great deal to whoever want to fetch the call metrics.

Regards
Dilip

2 Likes

Michael,

Any update on this request ? did you hear anything from your engineering team?

Regards
Dilip

Hey @Dilip_Reddy_Guda,

We do have a user_qos object on the response body for requesting Meeting Participant QOS.

Is this what you are looking for?

Thanks,
Tommy

Hi Tommy! You do, but this is separated by sample (one sample per minute). When you download the meeting’s details in the dashboard it gives you one consolidated number per user (I think it’s the average, is this correct?)

Would be great to be able to get this from the API.

Hi @nicolaskneler I don’t know that we’ll be able to provide this at this time. This API is used by many customers to diagnose changes through time for each Participant QoS.

Hi @michael.zoom! Ok, I understand. Do you have any resource to help us map this info?
We have students connecting from all over the world, and we need to find out if they are having QOS issues programmatically. If not averaging the data from the different samples, what would you recommend we do? Thank you!

Hey @nicolaskneler,

Your best bet is to leverage the Dashboard APIs.

You can also use the Meeting Alert webhook to be notified of any meeting issues.

Thanks,
Tommy

Thank you @tommy!

I have one last question, these QOS samples that Zoom provides per minute, are they averaging the activity of that minute, or are they one “millisecond” screenshot per minute? I hope the question is clear, I haven’t found documentation on this. Thank you.

Hey @nicolaskneler,

Can you clarify your question and a screenshot of what you are referring to? :slight_smile:

Thanks,
Tommy

Hi @tommy, sure!

When I make a call to the QOS endpoint, I get 1 sample per minute per participant, of all their QOS values (e.g. audio input bitrate). (this is a screenshot from a Google sheet where I dump the info I get from the endpoint)

My question is regarding those values I get, to understand if they represent an “average” of every second of that minute, or if they are a screenshot of the last second of each minute.

My guess is they are more of an “average”(in case of bitrate and latency, for example) since we have an Avg Packet Lost % and a Max Packet Lost %, which indicates that at some point during that minute there was a max packet loss, but we also get the avg value of each (second?) during that minute.

I hope the question is clearer now.
Thanks!

Hey @tommy! Any news regarding this?

Hey @nicolaskneler,

It depends on the field like you said, max for the minute, or average. Each one field in the docs should mention it.

Thanks,
Tommy

Thanks Tommy! Ok so if in a particular QOS sample (from the API) I get a 24ms Jitter, that means that during that minute, in average, the jitter was 24. Am I right to assume this?

Hey @nicolaskneler,

Yes that is correct.

Thanks,
Tommy

1 Like