type: object
properties:
parameters:
type: object
properties:
type:
default: live
enum:
- past
- live
type: string
example: past
description: |-
The type of webinar to query:
* `past` — All past webinars.
* `live` - All live webinars.
This value defaults to `live`.
from:
format: date
type: string
example: '2022-01-01'
description: >-
Start date in 'yyyy-mm-dd' format. The date range defined by the
"from" and "to" parameters should only be one month as the report
includes only one month worth of data at once.
to:
format: date
type: string
example: '2022-01-28'
description: End date.
page_size:
default: 30
maximum: 300
type: integer
example: 30
description: The number of records returned within a single API call.
next_page_token:
type: string
example: IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2
description: >-
Use the next page token to paginate through large result sets. A next
page token is returned whenever the set of available results exceeds
the current page size. This token's expiration period is 15 minutes.
group_id:
type: string
example: TaVA8QKik_1233
description: >-
The group ID. To get a group ID, use the [**List
groups**](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)
API.
**Note:** The API response will only contain meetings where the host is a member of the queried group ID.
required:
- from
- to
title: Parameters
type: object
properties:
from:
description: Start date for this report in 'yyyy-mm-dd' format.
format: date
type: string
example: '2022-01-01'
to:
description: End date for this report in 'yyyy-mm-dd' format.
format: date
type: string
example: '2022-01-30'
next_page_token:
description: >-
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.
type: string
example: Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3
page_count:
description: The number of pages returned for the request made.
type: integer
example: 1
page_size:
default: 30
description: The number of records returned within a single API call.
maximum: 300
type: integer
example: 30
total_records:
description: The number of all records available across pages.
type: integer
example: 1
webinars:
description: Array of webinar objects.
type: array
items:
type: object
title: Webinar Metrics
properties:
host:
description: User display name.
type: string
example:
[email protected]
custom_keys:
description: Custom keys and values assigned to the Webinar.
maxItems: 10
type: array
items:
type: object
properties:
key:
description: Custom key associated with the Webinar.
maxLength: 64
type: string
example: key1
value:
description: Value of the custom key associated with the Webinar.
maxLength: 256
type: string
example: value1
dept:
description: Department of the host.
type: string
example: Developers
duration:
description: >-
Webinar duration, formatted as hh:mm:ss, for example: `10:00` for
ten minutes.
type: string
example: '55:01'
email:
description: User email.
type: string
example:
[email protected]
end_time:
description: Webinar end time.
format: date-time
type: string
example: '2022-01-13T07:00:46Z'
has_3rd_party_audio:
description: Use TSP for the Webinar.
type: boolean
example: true
has_archiving:
description: Whether the archiving feature was used in the webinar.
type: boolean
example: true
has_pstn:
description: Indicates whether or not PSTN was used for the Webinar.
type: boolean
example: true
has_recording:
description: Indicates whether or not recording was used for the Webinar.
type: boolean
example: true
has_screen_share:
description: Indicates whether or not screen sharing was used for the Webinar.
type: boolean
example: true
has_sip:
description: Indicates whether or not SIP was used for the Webinar.
type: boolean
example: true
has_video:
description: Indicates whether or not video was used for the Webinar.
type: boolean
example: true
has_voip:
description: Indicates whether or not VoIP was used for the Webinar.
type: boolean
example: true
has_manual_captions:
description: Indicates whether a manual caption was enabled in the meeting.
type: boolean
example: true
has_automated_captions:
description: Indicates whether an automated caption was enabled in the meeting.
type: boolean
example: true
id:
description: >-
Webinar ID in "**long**" format(represented as int64 data type in
JSON), also known as the webinar number.
format: int64
type: integer
example: 99264817135
participants:
description: Webinar participant count.
type: integer
example: 1
start_time:
description: Webinar start time.
format: date-time
type: string
example: '2022-01-13T05:27:11Z'
topic:
description: Webinar topic.
type: string
example: my webinar
user_type:
description: User type.
type: string
example: Licensed
uuid:
description: Webinar UUID.
type: string
example: NknQtFSgSUSEYt2a9gc13A==
audio_quality:
type: string
description: >-
The webinar's [audio quality
score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts):
* `good` — The audio is almost flawless and the quality is
excellent.
* `fair` — The audio occasionally has distortion, noise, and other
problems, but the content is basically continuous. Participants can
communicate normally.
* `poor` — The audio often has distortion, noise, and other
problems, but the content is basically continuous. Participants can
communicate normally.
* `bad` — The sound quality is extremely poor and the audio content
is almost inaudible.
enum:
- good
- fair
- poor
- bad
example: good
video_quality:
type: string
description: >-
The webinar's [video quality
score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts):
* `good` — The video is almost flawless and the quality is
excellent.
* `fair` — The video definition is high, occasionally gets stuck,
fast or slow, or other problems, but the frequency is very low and
the video quality is good.
* `poor` — The video definition is not high, but not many problems
exist. The video quality is mediocre.
* `bad` — The picture is very blurred and often gets stuck.
enum:
- good
- fair
- poor
- bad
example: good
screen_share_quality:
type: string
description: >-
The webinar's [screen share quality
score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts):
* `good` — The video is almost flawless and the quality is
excellent.
* `fair` — The video definition is high, occasionally gets stuck,
fast or slow, or other problems, but the frequency is very low and
the video quality is good.
* `poor` — The video definition is not high, but not many problems
exist. The video quality is mediocre.
* `bad` — The picture is very blurred and often gets stuck.
enum:
- good
- fair
- poor
- bad
example: good