Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Analytics:Webinar API

6 actions 6 updates phrasing extends openapi/wistia-analytics-webinar-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Wistia's API. It is a proposal applied on top of the contract, not a document Wistia publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/analytics/webinars/{webinarId}'].get
$.paths['/analytics/webinars/{webinarId}/registration'].get
$.paths['/analytics/webinars/{webinarId}/traffic'].get
$.paths['/analytics/webinars/{webinarId}/audience'].get
$.paths['/analytics/webinars/{webinarId}/histograms'].get

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 Data Analytics:Webinar API
  version: 1.0.0
extends: openapi/wistia-analytics-webinar-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/analytics/webinars/{webinarId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a webinar's analytics
      effect: read
      questions:
      - How many people registered for and attended a webinar?
      - What chat and poll activity did one webinar get?
      instructions:
      - text: Show analytics for webinar {webinar}.
        slots:
          webinar: path.webinarId
      - text: Get webinar {webinar} analytics including post-event views.
        slots:
          webinar: path.webinarId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/webinars/{webinarId}/registration'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart a webinar's registrations over time
      effect: read
      questions:
      - How did registrations for a webinar build up over time?
      - What was a webinar's registration completion rate day by day?
      instructions:
      - text: Show the registration timeseries for webinar {webinar} by {granularity}.
        slots:
          webinar: path.webinarId
          granularity: query.granularity
      - text: Chart sign-ups for webinar {webinar} in {granularity} buckets.
        slots:
          webinar: path.webinarId
          granularity: query.granularity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/webinars/{webinarId}/traffic'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down a webinar's traffic sources
      effect: read
      questions:
      - Which UTM sources drove registrations to a webinar?
      - Which referring domains sent people to a webinar?
      instructions:
      - text: Break down traffic to webinar {webinar} by {group_by}.
        slots:
          webinar: path.webinarId
          group_by: query.group_by
      - text: Show which sources drove visitors to webinar {webinar}.
        slots:
          webinar: path.webinarId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/webinars/{webinarId}/audience'].get
  update:
    x-apievangelist-phrasing:
      intent: List a webinar's audience
      effect: read
      questions:
      - Who attended a webinar and how engaged were they?
      - Can I page through a webinar's registrants with their attendance status?
      instructions:
      - text: List the audience of webinar {webinar}.
        slots:
          webinar: path.webinarId
      - text: Show attendee engagement for webinar {webinar}, {per_page} per page.
        slots:
          webinar: path.webinarId
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/webinars/{webinarId}/histograms'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webinar's engagement histograms
      effect: read
      questions:
      - When during a webinar was chat activity highest?
      - Can I get attendee counts per time bucket to chart a webinar's engagement?
      instructions:
      - text: Get the engagement histograms for webinar {webinar}.
        slots:
          webinar: path.webinarId
      - text: Fetch attendee, chat and focus histograms for webinar {webinar}.
        slots:
          webinar: path.webinarId
      method: generated
      generated: '2026-10-01'