Zoom · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Zoom REST Dashboard API
10 actions
10 updates
phrasing
extends
openapi/zoom-dashboard-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Zoom's API. It is a proposal applied on top of the contract, not a document Zoom publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/metrics/crc'].post
$.paths['/metrics/im'].post
$.paths['/metrics/meetingdetail'].post
$.paths['/metrics/meetings'].post
$.paths['/metrics/qos'].post
$.paths['/metrics/webinardetail'].post
$.paths['/metrics/webinars'].post
$.paths['/metrics/zoomroomdetail'].post
$.paths['/metrics/zoomrooms'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Zoom REST Dashboard API
version: 1.0.0
extends: openapi/zoom-dashboard-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-24'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 9
- target: $.paths['/metrics/crc'].post
update:
x-apievangelist-phrasing:
intent: Get hourly CRC port usage
effect: read
questions:
- How busy were our Cloud Room Connector ports hour by hour?
- Can I see CRC port usage across a date range?
instructions:
- text: Show hourly CRC port usage from {from} to {to}.
slots:
from: requestBody.from
to: requestBody.to
- text: Get Cloud Room Connector port utilization between {from} and {to}.
slots:
from: requestBody.from
to: requestBody.to
method: generated
generated: '2026-09-24'
- target: $.paths['/metrics/im'].post
update:
x-apievangelist-phrasing:
intent: Get IM usage statistics
effect: read
questions:
- How much are people using instant messaging on our account?
- Can I get chat usage stats for a specific period?
instructions:
- text: Get instant messaging statistics from {from} to {to}.
slots:
from: requestBody.from
to: requestBody.to
- text: Show IM usage numbers between {from} and {to}, page {page_number}.
slots:
from: requestBody.from
to: requestBody.to
page_number: requestBody.page_number
method: generated
generated: '2026-09-24'
- target: $.paths['/metrics/meetingdetail'].post
update:
x-apievangelist-phrasing:
intent: Get dashboard details for one meeting
effect: read
questions:
- What does the dashboard show for a single live or past meeting?
- Can I drill into one meeting's details from the metrics dashboard?
instructions:
- text: Get dashboard details for meeting {meeting_id} of type {type}.
slots:
meeting_id: requestBody.meeting_id
type: requestBody.type
- text: Drill into {type} meeting {meeting_id} on the dashboard.
slots:
type: requestBody.type
meeting_id: requestBody.meeting_id
method: generated
generated: '2026-09-24'
- target: $.paths['/metrics/meetings'].post
update:
x-apievangelist-phrasing:
intent: List live or past meetings in a period
effect: read
questions:
- Which meetings are running right now across the account?
- Can I list past meetings on the dashboard for a date range?
instructions:
- text: List {type} meetings on the dashboard from {from} to {to}.
slots:
type: requestBody.type
from: requestBody.from
to: requestBody.to
- text: Show dashboard meetings of type {type} between {from} and {to}, {page_size} per page.
slots:
type: requestBody.type
from: requestBody.from
to: requestBody.to
page_size: requestBody.page_size
method: generated
generated: '2026-09-24'
- target: $.paths['/metrics/qos'].post
update:
x-apievangelist-phrasing:
intent: Get participants' quality of service in a meeting
effect: read
questions:
- Why did a meeting have bad audio or video, and whose connection was it?
- Can I check call quality for one participant in a meeting?
instructions:
- text: Get quality-of-service data for {type} meeting {meeting_id}.
slots:
type: requestBody.type
meeting_id: requestBody.meeting_id
- text: Show QoS for user {user_id} in {type} meeting {meeting_id}.
slots:
user_id: requestBody.user_id
type: requestBody.type
meeting_id: requestBody.meeting_id
method: generated
generated: '2026-09-24'
- target: $.paths['/metrics/webinardetail'].post
update:
x-apievangelist-phrasing:
intent: Get dashboard details for one webinar
effect: read
questions:
- What does the dashboard report for a single live or past webinar?
- Can I see participant details for one webinar in the metrics?
instructions:
- text: Get dashboard details for webinar {meeting_id} of type {type}.
slots:
meeting_id: requestBody.meeting_id
type: requestBody.type
- text: Drill into {type} webinar {meeting_id} on the dashboard.
slots:
type: requestBody.type
meeting_id: requestBody.meeting_id
method: generated
generated: '2026-09-24'
- target: $.paths['/metrics/webinars'].post
update:
x-apievangelist-phrasing:
intent: List live or past webinars in a period
effect: read
questions:
- Which webinars are live on our account right now?
- Can I pull the past webinars from the dashboard for last month?
instructions:
- text: List {type} webinars on the dashboard from {from} to {to}.
slots:
type: requestBody.type
from: requestBody.from
to: requestBody.to
- text: Show dashboard webinars of type {type} between {from} and {to}, page {page_number}.
slots:
type: requestBody.type
from: requestBody.from
to: requestBody.to
page_number: requestBody.page_number
method: generated
generated: '2026-09-24'
- target: $.paths['/metrics/zoomroomdetail'].post
update:
x-apievangelist-phrasing:
intent: Get dashboard details for one Zoom Room
effect: read
questions:
- How has one particular Zoom Room been used over a period?
- Can I see a single room's dashboard info by its ID?
instructions:
- text: Get dashboard details for Zoom Room {id} from {from} to {to}.
slots:
id: requestBody.id
from: requestBody.from
to: requestBody.to
- text: Show usage of room {id} between {from} and {to}.
slots:
id: requestBody.id
from: requestBody.from
to: requestBody.to
method: generated
generated: '2026-09-24'
- target: $.paths['/metrics/zoomrooms'].post
update:
x-apievangelist-phrasing:
intent: List all Zoom Rooms
effect: read
questions:
- What Zoom Rooms do we have on the account?
- Can I page through every conference room on the dashboard?
instructions:
- text: List all Zoom Rooms on the account.
- text: Show page {page_number} of our Zoom Rooms.
slots:
page_number: requestBody.page_number
method: generated
generated: '2026-09-24'