Zoom · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoom REST Report API

5 actions 5 updates phrasing extends openapi/zoom-report-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/report/getaccountreport'].post
$.paths['/report/getaudioreport'].post
$.paths['/report/getdailyreport'].post
$.paths['/report/getuserreport'].post

OpenAPI Overlay

Raw ↑
# 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 Report API
  version: 1.0.0
extends: openapi/zoom-report-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: 4
- target: $.paths['/report/getaccountreport'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the account usage report for a period
      effect: read
      questions:
      - How much has our whole account used Zoom over a date range?
      - Can I pull an account-wide usage report for last quarter?
      instructions:
      - text: Get the account report from {from} to {to}.
        slots:
          from: requestBody.from
          to: requestBody.to
      - text: Show account-wide usage between {from} and {to}, {page_size} per page.
        slots:
          from: requestBody.from
          to: requestBody.to
          page_size: requestBody.page_size
      method: generated
      generated: '2026-09-24'
- target: $.paths['/report/getaudioreport'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the toll audio report for a period
      effect: read
      questions:
      - What were our phone dial-in toll charges for a period?
      - What is the longest date range the audio toll report covers?
      instructions:
      - text: Get the toll audio report from {from} to {to}.
        slots:
          from: requestBody.from
          to: requestBody.to
      - text: Show {type} audio usage between {from} and {to}.
        slots:
          type: requestBody.type
          from: requestBody.from
          to: requestBody.to
      method: generated
      generated: '2026-09-24'
- target: $.paths['/report/getdailyreport'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the daily usage report for a month
      effect: read
      questions:
      - What did daily usage look like for a given month?
      - How far back can I pull the daily report?
      instructions:
      - text: Get the daily report for {month} {year}.
        slots:
          month: requestBody.month
          year: requestBody.year
      - text: Show day-by-day usage for month {month} of {year}.
        slots:
          month: requestBody.month
          year: requestBody.year
      method: generated
      generated: '2026-09-24'
- target: $.paths['/report/getuserreport'].post
  update:
    x-apievangelist-phrasing:
      intent: Get one user's usage report for a period
      effect: read
      questions:
      - How many meetings did a specific user host over a period?
      - Can I get a usage report for just one person?
      instructions:
      - text: Get the usage report for user {user_id} from {from} to {to}.
        slots:
          user_id: requestBody.user_id
          from: requestBody.from
          to: requestBody.to
      - text: Show meetings hosted by {user_id} between {from} and {to}.
        slots:
          user_id: requestBody.user_id
          from: requestBody.from
          to: requestBody.to
      method: generated
      generated: '2026-09-24'