Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Monitoring API

7 actions 7 updates phrasing extends openapi/mux-com-monitoring-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 7

$.info

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

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

$.paths['/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown'].get

$.paths['/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries'].get

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

$.paths['/data/v1/monitoring/metrics/{MONITORING_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 Monitoring API
  version: 1.0.0
extends: openapi/mux-com-monitoring-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/data/v1/monitoring/dimensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List live monitoring dimensions
      effect: read
      questions:
      - What dimensions can I break live monitoring data down by?
      - Which dimensions are available in the real-time monitoring dashboard?
      instructions:
      - text: List monitoring dimensions.
      - text: Show the dimensions available for live monitoring.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/monitoring/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List live monitoring metrics
      effect: read
      questions:
      - Which metrics can I watch in real time while people are viewing?
      - What monitoring metrics does Mux Data expose?
      instructions:
      - text: List monitoring metrics.
      - text: Show which metrics I can monitor live.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a live breakdown of a monitoring metric
      effect: read
      questions:
      - Right now, which CDN or region has the most concurrent viewers struggling?
      - Can I see concurrent viewers and negative impact per dimension value at a given moment?
      instructions:
      - text: Break down monitoring metric {monitoring_metric_id} by {dimension}.
        slots:
          monitoring_metric_id: path.MONITORING_METRIC_ID
          dimension: query.dimension
      - text: Show monitoring metric {monitoring_metric_id} by {dimension} at {timestamp}.
        slots:
          monitoring_metric_id: path.MONITORING_METRIC_ID
          dimension: query.dimension
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart a live breakdown over time
      effect: read
      questions:
      - How has each dimension value's live metric changed over the last few minutes?
      - Can I get a monitoring breakdown as 5-second datapoints?
      instructions:
      - text: Get the breakdown timeseries of monitoring metric {monitoring_metric_id} by {dimension}.
        slots:
          monitoring_metric_id: path.MONITORING_METRIC_ID
          dimension: query.dimension
      - text: Chart monitoring metric {monitoring_metric_id} by {dimension} over {timeframe}.
        slots:
          monitoring_metric_id: path.MONITORING_METRIC_ID
          dimension: query.dimension
          timeframe: query.timeframe[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/monitoring/metrics/{MONITORING_HISTOGRAM_METRIC_ID}/histogram-timeseries'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a live histogram timeseries for a metric
      effect: read
      questions:
      - Can I see the live distribution of a monitoring metric as a histogram over time?
      - Which monitoring metrics support histogram timeseries?
      instructions:
      - text: Get the histogram timeseries for monitoring metric {monitoring_histogram_metric_id}.
        slots:
          monitoring_histogram_metric_id: path.MONITORING_HISTOGRAM_METRIC_ID
      - text: Show the live histogram of {monitoring_histogram_metric_id} filtered by {filters}.
        slots:
          monitoring_histogram_metric_id: path.MONITORING_HISTOGRAM_METRIC_ID
          filters: query.filters[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a live metric timeseries with concurrent viewers
      effect: read
      questions:
      - How many people are watching right now and how is the metric trending?
      - Can I get a live monitoring metric over time along with concurrent viewers?
      instructions:
      - text: Track concurrent viewers alongside monitoring metric {monitoring_metric_id} over time.
        slots:
          monitoring_metric_id: path.MONITORING_METRIC_ID
      - text: Show monitoring metric {monitoring_metric_id} and concurrent viewers since {timestamp}.
        slots:
          monitoring_metric_id: path.MONITORING_METRIC_ID
          timestamp: query.timestamp
      method: generated
      generated: '2026-09-26'