Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Dimensions API

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

$.info
$.paths['/data/v1/dimensions'].get
$.paths['/data/v1/dimensions/{DIMENSION_ID}'].get
$.paths['/data/v1/dimensions/{DIMENSION_ID}/elements'].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 Mux Dimensions API
  version: 1.0.0
extends: openapi/mux-com-dimensions-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: 3
- target: $.paths['/data/v1/dimensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the dimensions I can break views down by
      effect: read
      questions:
      - What dimensions can I slice my video view data by?
      - Which basic and advanced dimensions does Mux Data offer?
      instructions:
      - text: List all available analytics dimensions.
      - text: Show me every dimension I can filter views on.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/dimensions/{DIMENSION_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: List values of a dimension with view counts
      effect: read
      questions:
      - Which browsers are my viewers using, and how many views does each have?
      - Can I see the top values for a dimension within a timeframe?
      instructions:
      - text: List values of dimension {dimension_id} with their view counts.
        slots:
          dimension_id: path.DIMENSION_ID
      - text: Show values for dimension {dimension_id} over {timeframe} filtered by {filters}.
        slots:
          dimension_id: path.DIMENSION_ID
          timeframe: query.timeframe[]
          filters: query.filters[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/dimensions/{DIMENSION_ID}/elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List elements of a trace dimension
      effect: read
      questions:
      - How do I see individual CDN hops in the video_cdn_trace dimension?
      - Can I count each element inside an array-valued trace dimension?
      instructions:
      - text: List elements of trace dimension {dimension_id}.
        slots:
          dimension_id: path.DIMENSION_ID
      - text: Show trace elements for {dimension_id} over {timeframe} ordered by {order_by}.
        slots:
          dimension_id: path.DIMENSION_ID
          timeframe: query.timeframe[]
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'