Get Zoom QoS

GET 
/adem/telemetry/v2/measure/zoom/qos

Retrieves Zoom meeting metrics as well as root cause analysis.

Request

Query Parameters

start int64

Possible values: <= 2147483648

The start time of the time range for which you want to retrieve the metrics. Specify in UNIX_TIMESTAMP_SECONDS, for example 1646252520

end int64

Possible values: <= 2147483648

The end time of the time range for which you want to retrieve the metrics. Specify in UNIX_TIMESTAMP_SECONDS, for example 1646263320

timerange string

Timerange over which you want to retrieve metrics, provided in readable format:

last__<minute|hour|day|week|month>

The responses are aggregated over a sample period which is a function of the time interval requested, such that the granularity decreases with increasing interval. See About Autonomous DEM API Timerange Parameter for details.

truncate-timerange boolean

Default value: true

filter string

Selects which fields to include in the query. Must use the format fieldvalue.
The following operators are supported: >=, <=, ==, !=, >, < See About Autonomous DEM API Filter Parameter for details.

response-type stringrequired

Possible values: [timeseries, summary, distribution, grouped-summary, grouped-timeseries, grouped-distribution]

Specifies the response type, such as 'timeseries' or 'group-summary'. See About Autonomous DEM API Response-Type Parameter for details.

group string

The entity by which to group the results. You can use entities such as endpoint, location, site, user, or test. You can specify multiple groups as a comma-separated list. For example, group=Entity.user, group=Entity.test,Entity.location

include string

Comma-separated list of values that identify additional properties to include in the response. See About Autonomous DEM API Include Parameter for details.

result-filter string

Limits results by filtering the output of the query, and maps to a HAVING statement (as compared with the input, which maps to a SELECT statement). Use the format, Score.==,..; For example, to limit score results by category, use Score.endpointScore==fair,good or Score.application==good;Score.lan==fair,good. See About Autonomous DEM API Result-filter Parameter for details.

pagination string

Use this parameter when the queries return a large number of results to limit the number of results in the response. See About Autonomous DEM API Pagination Parameter for details.

Header Parameters

Prisma-Tenant stringrequired

Used to specify a specific tenant.

Prisma-SubTenant string

This is an optional parameter. Specifies a sub-tenant of the Prisma-Tenant, if any.

Responses

200

Zoom QoS

application/json

Schema

Schema

oneOf

ZoomQosMetricSummary

average object

avgLossPercentage number

average packet loss, percent

bitrateKbps number

bitrate, kbps

frameRateFps number

frame rate, frames per second

jitter number

packet jitter (variation), milliseconds

latency number

packet latency, milliseconds

latitude number

computer latitude

longitude number

computer longitude

maxLossPercentage number

max packet loss, percent

resolution number

camera pixels

rootCause1 number

root cause 1 - high CPU usage

rootCause10 number

root cause 10 - global protect disconnect/connect

rootCause11 number

root cause 11 - high internet latency

rootCause12 number

root cause 12 - high internet jitter

rootCause13 number

root cause 13 - high internet loss

rootCause2 number

root cause 2 - high RAM usage

rootCause3 number

root cause 3 - poor wifi signal

rootCause4 number

root cause 4 - high network latency

rootCause5 number

root cause 5 - high network jitter

rootCause6 number

root cause 6 - high network loss

rootCause7 number

rootCause8 number

rootCause9 number

sample number

sample time (Unix timestamp)

score number

score, 0 - 100

systemMaxCpuUsagePercentage number

system maximum CPU usage

zoomAvgCpuUsagePercentage number

average CPU usage

zoomMaxCpuUsagePercentage number

maximum CPU usage

zoomMinCpuUsagePercentage number

minimum CPU usage

endTime number

sample end time (Unix timestamp)

endpointType string

endpoint type : muAgent, muProbe, rnAgent, rnProbe

entityCounts object

city number

count of distinct city name

country number

count of distinct country name

email number

count of distinct email

meetingUuid number

count of distinct meeting UUID

qosClass number

count of distinct QOS class

qosEventTime number

count of distinct QOS event time (minutes)

qosType number

count of distinct QOS type

userId number

count of distinct user ID

id stringrequired

pagination object

enabled boolean

limit number

page limit

page number

page number

sortBy string

sort by field

sortOrder string

sort order : asc, desc

rowCount number

startTime number

sample start time (Unix timestamp)

tenantServiceGroup string

array of tenant service groups

ZoomQosMetricSeries

endTime number

sample end time (Unix timestamp)

endpointType string

endpoint type : muAgent, muProbe, rnAgent, rnProbe

id stringrequired

pagination object

enabled boolean

limit number

page limit

page number

page number

sortBy string

sort by field

sortOrder string

sort order : asc, desc

rowCount number

samplePeriod number

sample period in seconds

series object[]

Array [

avgLossPercentage number

average packet loss, percent

bitrateKbps number

bitrate, kbps

frameRateFps number

frame rate, frames per second

jitter number

packet jitter (variation), milliseconds

latency number

packet latency, milliseconds

latitude number

computer latitude

longitude number

computer longitude

maxLossPercentage number

max packet loss, percent

resolution number

camera pixels

rootCause1 number

root cause 1 - high CPU usage

rootCause10 number

root cause 10 - global protect disconnect/connect

rootCause11 number

root cause 11 - high internet latency

rootCause12 number

root cause 12 - high internet jitter

rootCause13 number

root cause 13 - high internet loss

rootCause2 number

root cause 2 - high RAM usage

rootCause3 number

root cause 3 - poor wifi signal

rootCause4 number

root cause 4 - high network latency

rootCause5 number

root cause 5 - high network jitter

rootCause6 number

root cause 6 - high network loss

rootCause7 number

rootCause8 number

rootCause9 number

sample number

sample time (Unix timestamp)

score number

score, 0 - 100

systemMaxCpuUsagePercentage number

system maximum CPU usage

zoomAvgCpuUsagePercentage number

average CPU usage

zoomMaxCpuUsagePercentage number

maximum CPU usage

zoomMinCpuUsagePercentage number

minimum CPU usage

]

seriesEntityCount object[]

Array [

city number

count of distinct city name

country number

count of distinct country name

email number

count of distinct email

meetingUuid number

count of distinct meeting UUID

qosClass number

count of distinct QOS class

qosEventTime number

count of distinct QOS event time (minutes)

qosType number

count of distinct QOS type

userId number

count of distinct user ID

]

startTime number

sample start time (Unix timestamp)

tenantServiceGroup string

array of tenant service groups

ZoomQosMetricDistribution

classifier string

score classifier e.g. poor:[0 - 30],fair:[30 - 70],good:[70 - 100]

distribution object

clients number

count of distribution entity e.g. application tests, endpoints

fair number

count of scores classified as fair

good number

count of scores classified as good

poor number

count of scores classified as poor

score number

average of all scores in distribution

endTime number

sample end time (Unix timestamp)

endpointType string

endpoint type : muAgent, muProbe, rnAgent, rnProbe

entityCounts object

city number

count of distinct city name

country number

count of distinct country name

email number

count of distinct email

meetingUuid number

count of distinct meeting UUID

qosClass number

count of distinct QOS class

qosEventTime number

count of distinct QOS event time (minutes)

qosType number

count of distinct QOS type

userId number

count of distinct user ID

id string

pagination object

enabled boolean

limit number

page limit

page number

page number

sortBy string

sort by field

sortOrder string

sort order : asc, desc

rowCount number

startTime number

sample start time (Unix timestamp)

tenantServiceGroup string

array of tenant service groups

ZoomQosMetricSummaryCollection

collection object[]

Array [

average object

avgLossPercentage number

average packet loss, percent

bitrateKbps number

bitrate, kbps

frameRateFps number

frame rate, frames per second

jitter number

packet jitter (variation), milliseconds

latency number

packet latency, milliseconds

latitude number

computer latitude

longitude number

computer longitude

maxLossPercentage number

max packet loss, percent

resolution number

camera pixels

rootCause1 number

root cause 1 - high CPU usage

rootCause10 number

root cause 10 - global protect disconnect/connect

rootCause11 number

root cause 11 - high internet latency

rootCause12 number

root cause 12 - high internet jitter

rootCause13 number

root cause 13 - high internet loss

rootCause2 number

root cause 2 - high RAM usage

rootCause3 number

root cause 3 - poor wifi signal

rootCause4 number

root cause 4 - high network latency

rootCause5 number

root cause 5 - high network jitter

rootCause6 number

root cause 6 - high network loss

rootCause7 number

rootCause8 number

rootCause9 number

sample number

sample time (Unix timestamp)

score number

score, 0 - 100

systemMaxCpuUsagePercentage number

system maximum CPU usage

zoomAvgCpuUsagePercentage number

average CPU usage

zoomMaxCpuUsagePercentage number

maximum CPU usage

zoomMinCpuUsagePercentage number

minimum CPU usage

endTime number

sample end time (Unix timestamp)

endpointType string

endpoint type : muAgent, muProbe, rnAgent, rnProbe

entityCounts object

city number

count of distinct city name

country number

count of distinct country name

email number

count of distinct email

meetingUuid number

count of distinct meeting UUID

qosClass number

count of distinct QOS class

qosEventTime number

count of distinct QOS event time (minutes)

qosType number

count of distinct QOS type

userId number

count of distinct user ID

id stringrequired

pagination object

enabled boolean

limit number

page limit

page number

page number

sortBy string

sort by field

sortOrder string

sort order : asc, desc

rowCount number

startTime number

sample start time (Unix timestamp)

tenantServiceGroup string

array of tenant service groups

]

endTime number

sample end time (Unix timestamp)

endpointType string

endpoint type : muAgent, muProbe, rnAgent, rnProbe

pagination object

enabled boolean

limit number

page limit

page number

page number

sortBy string

sort by field

sortOrder string

sort order : asc, desc

rowCount number

startTime number

sample start time (Unix timestamp)

tenantServiceGroup string

array of tenant service groups

ZoomQosMetricSeriesCollection

collection object[]

Array [

endTime number

sample end time (Unix timestamp)

endpointType string

endpoint type : muAgent, muProbe, rnAgent, rnProbe

id stringrequired

pagination object

enabled boolean

limit number

page limit

page number

page number

sortBy string

sort by field

sortOrder string

sort order : asc, desc

rowCount number

samplePeriod number

sample period in seconds

series object[]

Array [

avgLossPercentage number

average packet loss, percent

bitrateKbps number

bitrate, kbps

frameRateFps number

frame rate, frames per second

jitter number

packet jitter (variation), milliseconds

latency number

packet latency, milliseconds

latitude number

computer latitude

longitude number

computer longitude

maxLossPercentage number

max packet loss, percent

resolution number

camera pixels

rootCause1 number

root cause 1 - high CPU usage

rootCause10 number

root cause 10 - global protect disconnect/connect

rootCause11 number

root cause 11 - high internet latency

rootCause12 number

root cause 12 - high internet jitter

rootCause13 number

root cause 13 - high internet loss

rootCause2 number

root cause 2 - high RAM usage

rootCause3 number

root cause 3 - poor wifi signal

rootCause4 number

root cause 4 - high network latency

rootCause5 number

root cause 5 - high network jitter

rootCause6 number

root cause 6 - high network loss

rootCause7 number

rootCause8 number

rootCause9 number

sample number

sample time (Unix timestamp)

score number

score, 0 - 100

systemMaxCpuUsagePercentage number

system maximum CPU usage

zoomAvgCpuUsagePercentage number

average CPU usage

zoomMaxCpuUsagePercentage number

maximum CPU usage

zoomMinCpuUsagePercentage number

minimum CPU usage

]

seriesEntityCount object[]

Array [

city number

count of distinct city name

country number

count of distinct country name

email number

count of distinct email

meetingUuid number

count of distinct meeting UUID

qosClass number

count of distinct QOS class

qosEventTime number

count of distinct QOS event time (minutes)

qosType number

count of distinct QOS type

userId number

count of distinct user ID

]

startTime number

sample start time (Unix timestamp)

tenantServiceGroup string

array of tenant service groups

]

endTime number

sample end time (Unix timestamp)

endpointType string

endpoint type : muAgent, muProbe, rnAgent, rnProbe

pagination object

enabled boolean

limit number

page limit

page number

page number

sortBy string

sort by field

sortOrder string

sort order : asc, desc

rowCount number

samplePeriod number

sample period in seconds

startTime number

sample start time (Unix timestamp)

tenantServiceGroup string

array of tenant service groups

ZoomQosMetricDistributionCollection

classifier string

collection object[]

Array [

classifier string

score classifier e.g. poor:[0 - 30],fair:[30 - 70],good:[70 - 100]

distribution object

clients number

count of distribution entity e.g. application tests, endpoints

fair number

count of scores classified as fair

good number

count of scores classified as good

poor number

count of scores classified as poor

score number

average of all scores in distribution

endTime number

sample end time (Unix timestamp)

endpointType string

endpoint type : muAgent, muProbe, rnAgent, rnProbe

entityCounts object

city number

count of distinct city name

country number

count of distinct country name

email number

count of distinct email

meetingUuid number

count of distinct meeting UUID

qosClass number

count of distinct QOS class

qosEventTime number

count of distinct QOS event time (minutes)

qosType number

count of distinct QOS type

userId number

count of distinct user ID

id string

pagination object

enabled boolean

limit number

page limit

page number

page number

sortBy string

sort by field

sortOrder string

sort order : asc, desc

rowCount number

startTime number

sample start time (Unix timestamp)

tenantServiceGroup string

array of tenant service groups

]

endTime number

sample end time (Unix timestamp)

endpointType string

endpoint type : muAgent, muProbe, rnAgent, rnProbe

entityCounts object

city number

count of distinct city name

country number

count of distinct country name

email number

count of distinct email

meetingUuid number

count of distinct meeting UUID

qosClass number

count of distinct QOS class

qosEventTime number

count of distinct QOS event time (minutes)

qosType number

count of distinct QOS type

userId number

count of distinct user ID

pagination object

enabled boolean

limit number

page limit

page number

page number

sortBy string

sort by field

sortOrder string

sort order : asc, desc

rowCount number

startTime number

sample start time (Unix timestamp)

tenantServiceGroup string

array of tenant service groups

Example (from schema)

{}

400

Invalid Request

401

Invalid Client

500

Server Error

Loading...