action zoom_dashboard_webinar_detail {
label: "Get webinar details"
description: "Retrieve details from live or past webinars.
\n**Scopes:** `dashboard_webinars:read:admin`
\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
\n**Prerequisites:**
\n* Business, Education or API Plan with Webinar add-on.\n\n"
provider: zoom
method: GET
path: "/metrics/webinars/{webinarId}"
encoding: json
input: {
type: "object"
properties: {
type: {
type: "string"
enum: ["past", "live"]
}
webinarId: {
type: "string"
}
}
required: ["webinarId"]
additionalProperties: false
}
output: {
type: "object"
description: "Webinar metric details."
properties: {
custom_keys: {
type: "array"
description: "Custom keys and values assigned to the Webinar."
items: {
type: "object"
properties: {
key: {
type: "string"
description: "Custom key associated with the Webinar."
}
value: {
type: "string"
description: "Value of the custom key associated with the Webinar."
}
}
}
}
dept: {
type: "string"
description: "Department of the host."
}
duration: {
type: "string"
description: "Webinar duration, formatted as hh:mm:ss, for example: `10:00` for ten minutes."
}
email: {
type: "string"
description: "User email."
}
end_time: {
type: "string"
format: "date-time"
description: "Webinar end time."
}
has_3rd_party_audio: {
type: "boolean"
description: "Indicates whether or not TSP was used for the Webinar."
}
has_pstn: {
type: "boolean"
description: "Indicates whether or not PSTN was used for the Webinar."
}
has_recording: {
type: "boolean"
description: "Indicates whether or not recording was used for the Webinar."
}
has_screen_share: {
type: "boolean"
description: "Indicates whether or not screen sharing was used for the Webinar."
}
has_sip: {
type: "boolean"
description: "Indicates whether or not SIP was used for the Webinar."
}
has_video: {
type: "boolean"
description: "Indicates whether or not video was used for the Webinar."
}
has_voip: {
type: "boolean"
description: "Indicates whether or not VoIP was used for the Webinar."
}
host: {
type: "string"
description: "User display name."
}
id: {
type: "integer"
format: "int64"
description: "Webinar ID in \"**long**\" format(represented as int64 data type in JSON), also known as the webinar number."
}
participants: {
type: "integer"
description: "Webinar participant count."
}
start_time: {
type: "string"
format: "date-time"
description: "Webinar start time."
}
topic: {
type: "string"
description: "Webinar topic."
}
user_type: {
type: "string"
description: "User type."
}
uuid: {
type: "string"
format: "uuid"
description: "Webinar UUID."
}
}
}
}