Back to ZoomGet Webinar Detail Reports
Retrieve a report containing past webinar details.
Scopes: report:read:admin
Rate Limit Label: Heavy
Prerequisites:
- Pro or higher plan with Webinar add-on.
Input
type: object
properties:
parameters:
type: object
properties:
webinarId:
type: string
example: ABCDE12345
description: >-
The webinar's ID or universally unique ID (UUID).
* If you provide a webinar ID, the API will return a response for the
latest webinar instance.
* If you provide a webinar UUID that begins with a `/` character or
contains the `//` characters, you **must** [double
encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)
the webinar UUID before making an API request.
required:
- webinarId
title: Parameters
Output
type: object
properties:
custom_keys:
description: Custom keys and values assigned to the meeting.
maxItems: 10
type: array
items:
type: object
properties:
key:
description: Custom key associated with the user.
maxLength: 64
type: string
example: Host Nation
value:
description: Value of the custom key associated with the user.
maxLength: 256
type: string
example: US
dept:
description: Department of the host.
type: string
example: HR
duration:
description: Meeting duration.
type: integer
example: 2
end_time:
description: Meeting end time.
format: date-time
type: string
example: '2022-03-15T07:42:22Z'
id:
description: >-
[Meeting
ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-):
Unique identifier of the meeting in "**long**" format(represented as int64
data type in JSON), also known as the meeting number.
format: int64
type: integer
example: 345678902224
participants_count:
description: Number of meeting participants.
type: integer
example: 4
start_time:
description: Meeting start time.
format: date-time
type: string
example: '2022-03-15T07:40:46Z'
topic:
description: Meeting topic.
type: string
example: My Meeting
total_minutes:
description: >-
Number of Webinar minutes. This represents the total amount of Webinar
minutes attended by each participant including the host, for a Webinar
hosted by the user. For instance if there were one host(named A) and one
participant(named B) in a Webinar, the value of total_minutes would be
calculated as below:
**total_minutes** = Total Webinar Attendance Minutes of A + Total Webinar
Attendance Minutes of B
type: integer
example: 3
tracking_fields:
description: Tracking fields.
type: array
items:
type: object
properties:
field:
description: Tracking fields type.
type: string
example: Host Nation
value:
description: Tracking fields value.
type: string
example: US
type:
description: Meeting type.
type: integer
example: 4
user_email:
description: User email.
type: string
example:
[email protected]
user_name:
description: User display name.
type: string
example: Jill Chill
uuid:
description: >-
Webinar UUID. Each webinar instance will generate its own UUID(i.e., after
a meeting ends, a new UUID will be generated when the next instance of the
webinar starts). [double
encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)
the UUID when using it for API calls if the UUID begins with a '/' or
contains '//' in it.
type: string
example: 4444AAAiAAAAAiAiAiiAii==