Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Filters API

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

$.info

$.paths['/data/v1/filters'].get

$.paths['/data/v1/filters/{FILTER_ID}'].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 Filters API
  version: 1.0.0
extends: openapi/mux-com-filters-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: 2
- target: $.paths['/data/v1/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List analytics filters (legacy)
      effect: read
      questions:
      - What basic and advanced filters exist in the old filters API?
      - Is the filters list still available now that dimensions replaced it?
      instructions:
      - text: List all filters using the legacy filters endpoint.
      - text: Show basic and advanced filters from the old filters call.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/filters/{FILTER_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: List values of a filter (legacy)
      effect: read
      questions:
      - Can I still get values and view counts for a filter via the old API?
      - Which values does a given legacy filter have over a timeframe?
      instructions:
      - text: List values of legacy filter {filter_id}.
        slots:
          filter_id: path.FILTER_ID
      - text: Show values of filter {filter_id} over {timeframe} using the old filters API.
        slots:
          filter_id: path.FILTER_ID
          timeframe: query.timeframe[]
      method: generated
      generated: '2026-09-26'