Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Real Time API

6 actions 6 updates phrasing extends openapi/mux-com-realtime-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Mux's API. It is a proposal applied on top of the contract, not a document Mux publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/data/v1/realtime/dimensions'].get

$.paths['/data/v1/realtime/metrics'].get

$.paths['/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown'].get

$.paths['/data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries'].get

$.paths['/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries'].get

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 Mux Real Time API
  version: 1.0.0
extends: openapi/mux-com-realtime-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['/data/v1/realtime/dimensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List real-time dimensions (deprecated)
      effect: read
      questions:
      - Which dimensions does the deprecated real-time API expose?
      - Is the old real-time dimensions list still callable?
      instructions:
      - text: List dimensions from the deprecated real-time API.
      - text: Show the legacy real-time dimensions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/v1/realtime/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List real-time metrics (deprecated)
      effect: read
      questions:
      - Which metrics does the older real-time API offer?
      - Can I still list metrics via the deprecated real-time endpoint?
      instructions:
      - text: List metrics from the deprecated real-time API.
      - text: Show the legacy real-time metrics.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a real-time breakdown (deprecated)
      effect: read
      questions:
      - Can I still pull a concurrent-viewer breakdown from the old real-time API?
      - What does the deprecated real-time breakdown return per dimension?
      instructions:
      - text: Break down real-time metric {realtime_metric_id} by {dimension} using the deprecated API.
        slots:
          realtime_metric_id: path.REALTIME_METRIC_ID
          dimension: query.dimension
      - text: Get the legacy real-time breakdown of {realtime_metric_id} at {timestamp}.
        slots:
          realtime_metric_id: path.REALTIME_METRIC_ID
          timestamp: query.timestamp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a real-time histogram timeseries (deprecated)
      effect: read
      questions:
      - Is the older real-time histogram timeseries still available?
      - Where do legacy integrations get histogram data from the real-time API?
      instructions:
      - text: Get the deprecated real-time histogram timeseries for {realtime_histogram_metric_id}.
        slots:
          realtime_histogram_metric_id: path.REALTIME_HISTOGRAM_METRIC_ID
      - text: Pull the legacy real-time histogram of {realtime_histogram_metric_id} filtered by {filters}.
        slots:
          realtime_histogram_metric_id: path.REALTIME_HISTOGRAM_METRIC_ID
          filters: query.filters[]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a real-time timeseries (deprecated)
      effect: read
      questions:
      - Can the deprecated real-time API still give me concurrent viewers over time?
      - What replaced the old real-time timeseries call?
      instructions:
      - text: Track concurrent viewers with legacy real-time metric {realtime_metric_id} via the deprecated API.
        slots:
          realtime_metric_id: path.REALTIME_METRIC_ID
      - text: Pull legacy real-time metric {realtime_metric_id} over time since {timestamp}.
        slots:
          realtime_metric_id: path.REALTIME_METRIC_ID
          timestamp: query.timestamp
      method: generated
      generated: '2026-10-01'