openapi: 3.0.0
info:
  title: Mux API
  description: >-
    Mux is how developers build online video. This API encompasses both Mux
    Video and Mux Data functionality to help you build your video-related
    projects better and faster than ever before.


    Contact Support:
     Name: Mux DevEx
     Email: devex@mux.com
  version: 1.0.0
servers:
  - url: http://{{baseurl}}
  - url: http://{{basemuxurl}}
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
security:
  - basicAuth: []
tags:
  - name: video/v1
  - name: video/v1 > spaces
  - name: video/v1 > spaces > {SPACE_ID}
  - name: video/v1 > spaces > {SPACE_ID} > broadcasts
  - name: video/v1 > spaces > {SPACE_ID} > broadcasts > {BROADCAST_ID}
  - name: video/v1 > transcription-vocabularies
  - name: video/v1 > transcription-vocabularies > {TRANSCRIPTION_VOCABULARY_ID}
  - name: video/v1 > assets
  - name: video/v1 > assets > {ASSET_ID}
  - name: video/v1 > assets > {ASSET_ID} > playback-ids
  - name: video/v1 > assets > {ASSET_ID} > playback-ids > {PLAYBACK_ID}
  - name: video/v1 > assets > {ASSET_ID} > tracks
  - name: video/v1 > live-streams
  - name: video/v1 > live-streams > {LIVE_STREAM_ID}
  - name: video/v1 > live-streams > {LIVE_STREAM_ID} > playback-ids
  - name: video/v1 > live-streams > {LIVE_STREAM_ID} > playback-ids > {PLAYBACK_ID}
  - name: video/v1 > live-streams > {LIVE_STREAM_ID} > simulcast-targets
  - name: >-
      video/v1 > live-streams > {LIVE_STREAM_ID} > simulcast-targets >
      {SIMULCAST_TARGET_ID}
  - name: video/v1 > signing-keys
  - name: video/v1 > signing-keys > {SIGNING_KEY_ID}
  - name: video/v1 > uploads
  - name: video/v1 > uploads > {UPLOAD_ID}
  - name: video/v1 > playback-restrictions
  - name: video/v1 > playback-restrictions > {PLAYBACK_RESTRICTION_ID}
  - name: data/v1
  - name: data/v1 > video-views
  - name: data/v1 > filters
  - name: data/v1 > dimensions
  - name: data/v1 > exports
  - name: data/v1 > metrics
  - name: data/v1 > metrics > {METRIC_ID}
  - name: data/v1 > monitoring
  - name: data/v1 > monitoring > metrics
  - name: data/v1 > monitoring > metrics > {MONITORING_METRIC_ID}
  - name: data/v1 > realtime
  - name: data/v1 > realtime > metrics
  - name: data/v1 > realtime > metrics > {REALTIME_METRIC_ID}
  - name: data/v1 > incidents
  - name: data/v1 > incidents > {INCIDENT_ID}
  - name: system/v1/signing-keys
  - name: system/v1/signing-keys > {SIGNING_KEY_ID}
paths:
  /video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID}:
    get:
      tags:
        - video/v1 > spaces > {SPACE_ID} > broadcasts > {BROADCAST_ID}
      summary: Retrieve space broadcast
      description: Retrieves the details of a broadcast of a specific space.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: SPACE_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The space ID.
          example: do ea cupidatat cillum ipsum
        - name: BROADCAST_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The broadcast ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: uylLl3WuQ54CwqUB9UHySxnN66sqKue5
                  live_stream_id: GQ9025mPqzyjOy3kKQW006qKTqmULW9vFO
                  resolution: 1920x1080
                  layout: gallery
                  status: idle
    delete:
      tags:
        - video/v1 > spaces > {SPACE_ID} > broadcasts > {BROADCAST_ID}
      summary: Delete a space broadcast
      description: >-
        Deletes a single broadcast of a specific space. Broadcasts can only be
        deleted when `idle`.
      parameters:
        - name: SPACE_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The space ID.
          example: do ea cupidatat cillum ipsum
        - name: BROADCAST_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The broadcast ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID}/start:
    post:
      tags:
        - video/v1 > spaces > {SPACE_ID} > broadcasts > {BROADCAST_ID}
      summary: Start a space broadcast
      description: >-
        Starts broadcasting a space to the associated destination. Broadcasts
        can only be started when the space is `active` (when there are
        participants connected).
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: SPACE_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The space ID.
          example: do ea cupidatat cillum ipsum
        - name: BROADCAST_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The broadcast ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data: {}
  /video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID}/stop:
    post:
      tags:
        - video/v1 > spaces > {SPACE_ID} > broadcasts > {BROADCAST_ID}
      summary: Stop a space broadcast
      description: >-
        Stops broadcasting a space, causing the destination live stream to
        become idle. This API also automatically calls `complete` on the
        destination live stream.

        Broadcasts are also automatically stopped when a space becomes idle.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: SPACE_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The space ID.
          example: do ea cupidatat cillum ipsum
        - name: BROADCAST_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The broadcast ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data: {}
  /video/v1/spaces/{SPACE_ID}/broadcasts:
    post:
      tags:
        - video/v1 > spaces > {SPACE_ID} > broadcasts
      summary: Create a space broadcast
      description: >-
        Creates a new broadcast. Broadcasts are used to create composited
        versions of your space, which can be broadcast to live streams.

        **Note:** By default only a single broadcast destination can be
        specified. Contact Mux support if you need more.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                live_stream_id: GQ9025mPqzyjOy3kKQW006qKTqmULW9vFO
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: SPACE_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The space ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: uylLl3WuQ54CwqUB9UHySxnN66sqKue5
                  live_stream_id: GQ9025mPqzyjOy3kKQW006qKTqmULW9vFO
                  resolution: 1920x1080
                  layout: gallery
                  status: idle
  /video/v1/spaces/{SPACE_ID}:
    get:
      tags:
        - video/v1 > spaces > {SPACE_ID}
      summary: Retrieve a space
      description: >-
        Retrieves the details of a space that has previously been created.
        Supply the unique space ID that was returned from your create space
        request, and Mux will return the information about the corresponding
        space. The same information is returned when creating a space.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: SPACE_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The space ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  type: server
                  id: uylLl3WuQ54CwqUB9UHySxnN66sqKue5
                  created_at: '1607452572'
                  status: idle
    delete:
      tags:
        - video/v1 > spaces > {SPACE_ID}
      summary: Delete a space
      description: Deletes a space. Spaces can only be deleted when `idle`.
      parameters:
        - name: SPACE_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The space ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /video/v1/spaces:
    post:
      tags:
        - video/v1 > spaces
      summary: Create a space
      description: >-
        Create a new space. Spaces are used to build [real-time video
        applications.](https://mux.com/real-time-video)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                type: server
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  type: server
                  id: uylLl3WuQ54CwqUB9UHySxnN66sqKue5
                  created_at: '1607452572'
                  status: idle
    get:
      tags:
        - video/v1 > spaces
      summary: List spaces
      description: List all spaces in the current enviroment.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - type: server
                    id: uylLl3WuQ54CwqUB9UHySxnN66sqKue5
                    created_at: '1607452572'
                    status: idle
                  - type: server
                    id: HK01Bq7FrEQmIu3QpRiZZ98HQOOZjm6B
                    created_at: '1693452572'
                    status: active
  /video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}:
    get:
      tags:
        - video/v1 > transcription-vocabularies > {TRANSCRIPTION_VOCABULARY_ID}
      summary: Retrieve a Transcription Vocabulary
      description: >-
        Retrieves the details of a Transcription Vocabulary that has previously
        been created. Supply the unique Transcription Vocabulary ID and Mux will
        return the corresponding Transcription Vocabulary information. The same
        information is returned when creating a Transcription Vocabulary.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: TRANSCRIPTION_VOCABULARY_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the Transcription Vocabulary.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: VDm3npt2eaEDvz9emzun8Q
                  name: Mux API Vocabulary
                  phrases:
                    - Mux
                    - Live Stream
                    - Playback ID
                    - video encoding
                  created_at: '1609869152'
                  updated_at: '1609870000'
    delete:
      tags:
        - video/v1 > transcription-vocabularies > {TRANSCRIPTION_VOCABULARY_ID}
      summary: Delete a Transcription Vocabulary
      description: >-
        Deletes a Transcription Vocabulary. The Transcription Vocabulary's ID
        will be disassociated from any live streams using it. Transcription
        Vocabularies can be deleted while associated live streams are active.
        However, the words and phrases in the deleted Transcription Vocabulary
        will remain attached to those streams while they are active.
      parameters:
        - name: TRANSCRIPTION_VOCABULARY_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the Transcription Vocabulary.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
    put:
      tags:
        - video/v1 > transcription-vocabularies > {TRANSCRIPTION_VOCABULARY_ID}
      summary: Update a Transcription Vocabulary
      description: >-
        Updates the details of a previously-created Transcription Vocabulary.
        Updates to Transcription Vocabularies are allowed while associated live
        streams are active. However, updates will not be applied to those
        streams while they are active.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: Mux API Vocabulary - Updated
                phrases:
                  - Mux
                  - Live Stream
                  - RTMP
                  - Stream Key
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: TRANSCRIPTION_VOCABULARY_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the Transcription Vocabulary.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: VDm3npt2eaEDvz9emzun8Q
                  name: Mux API Vocabulary - Updated
                  phrases:
                    - Mux
                    - Live Stream
                    - RTMP
                    - Stream Key
                  created_at: '1609869152'
                  updated_at: '1609870000'
  /video/v1/transcription-vocabularies:
    post:
      tags:
        - video/v1 > transcription-vocabularies
      summary: Create a Transcription Vocabulary
      description: Create a new Transcription Vocabulary.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: Mux API Vocabulary
                phrases:
                  - Mux
                  - Live Stream
                  - Playback ID
                  - video encoding
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: VDm3npt2eaEDvz9emzun8Q
                  name: Mux API Vocabulary
                  phrases:
                    - Mux
                    - Live Stream
                    - Playback ID
                    - video encoding
                  created_at: '1609869152'
                  updated_at: '1609869152'
    get:
      tags:
        - video/v1 > transcription-vocabularies
      summary: List Transcription Vocabularies
      description: List all Transcription Vocabularies.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - id: VDm3npt2eaEDvz9emzun8Q
                    name: Mux API Vocabulary
                    phrases:
                      - Mux
                      - Live Stream
                      - Playback ID
                      - video encoding
                    created_at: '1609869152'
                    updated_at: '1609870000'
                  - id: M1lDlzSP102NgukTnyQyLqw
                    name: Video Codecs
                    phrases:
                      - h.264
                      - HEVC
                      - AV1
                    created_at: '1609869152'
                    updated_at: '1609870000'
  /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}:
    get:
      tags:
        - video/v1 > assets > {ASSET_ID} > playback-ids > {PLAYBACK_ID}
      summary: Retrieve a playback ID
      description: Retrieves information about the specified playback ID.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
        - name: PLAYBACK_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream's playback ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  policy: public
                  id: vAFLI2eKFFicXX00iHBS2vqt5JjJGg5HV6fQ4Xijgt1I
    delete:
      tags:
        - video/v1 > assets > {ASSET_ID} > playback-ids > {PLAYBACK_ID}
      summary: Delete a playback ID
      description: >-
        Deletes a playback ID, rendering it nonfunctional for viewing an asset's
        video content. Please note that deleting the playback ID removes access
        to the underlying asset; a viewer who started playback before the
        playback ID was deleted may be able to watch the entire video for a
        limited duration.
      parameters:
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
        - name: PLAYBACK_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream's playback ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /video/v1/assets/{ASSET_ID}/playback-ids:
    post:
      tags:
        - video/v1 > assets > {ASSET_ID} > playback-ids
      summary: Create a playback ID
      description: Creates a playback ID that can be used to stream the asset to a viewer.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                policy: public
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  policy: public
                  id: Lj02VZDorh9hCV00flNqPli8fmwf6KEppug01w8zDEYVlQ
  /video/v1/assets/{ASSET_ID}/tracks:
    post:
      tags:
        - video/v1 > assets > {ASSET_ID} > tracks
      summary: Create an asset track
      description: Adds an asset track (for example, subtitles) to an asset.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                url: https://example.com/myVideo_en.srt
                type: text
                text_type: subtitles
                language_code: en-US
                name: English
                closed_captions: true
                passthrough: English
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  type: text
                  text_type: subtitles
                  status: preparing
                  passthrough: English
                  name: English
                  language_code: en-US
                  id: xBe7u01029ipxBLQhYzZCJ1cke01zCkuUsgnYtH0017nNzbpv2YcsoMDmw
                  closed_captions: true
  /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}:
    delete:
      tags:
        - video/v1 > assets > {ASSET_ID} > tracks
      summary: Delete an asset track
      description: >-
        Removes a text track from an asset. Audio and video tracks on assets
        cannot be removed.
      parameters:
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
        - name: TRACK_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The track ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /video/v1/assets/{ASSET_ID}:
    get:
      tags:
        - video/v1 > assets > {ASSET_ID}
      summary: Retrieve an asset
      description: >-
        Retrieves the details of an asset that has previously been created.
        Supply the unique asset ID that was returned from your previous request,
        and Mux will return the corresponding asset information. The same
        information is returned when creating an asset.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  tracks:
                    - type: video
                      max_width: 1920
                      max_height: 1080
                      max_frame_rate: 29.97
                      id: RiyQPM31a1SPtfI802bEP2zD02F5FQVNL801FRHeE5t01G4
                      duration: 23.8238
                    - type: audio
                      max_channels: 2
                      id: LvINTciHVoC017knMCH01y9pSi5OrDLCRaBPNDAoNJcmg
                      duration: 23.823792
                  status: ready
                  playback_ids:
                    - policy: public
                      id: vAFLI2eKFFicXX00iHBS2vqt5JjJGg5HV6fQ4Xijgt1I
                  mp4_support: none
                  max_stored_resolution: HD
                  resolution_tier: 1080p
                  max_stored_frame_rate: 29.97
                  master_access: none
                  id: lJ4bGGsp7ZlPf02nMg015W02iHQLN9XnuuLRBsPS00xqd68
                  duration: 23.857167
                  created_at: '1609868768'
                  aspect_ratio: '16:9'
    delete:
      tags:
        - video/v1 > assets > {ASSET_ID}
      summary: Delete an asset
      description: Deletes a video asset and all its data.
      parameters:
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
    patch:
      tags:
        - video/v1 > assets > {ASSET_ID}
      summary: Update an Asset
      description: >-
        Updates the details of an already-created Asset with the provided Asset
        ID. This currently supports only the `passthrough` field.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                passthrough: Example
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  tracks:
                    - type: video
                      max_width: 1920
                      max_height: 1080
                      max_frame_rate: 29.97
                      id: RiyQPM31a1SPtfI802bEP2zD02F5FQVNL801FRHeE5t01G4
                      duration: 23.8238
                    - type: audio
                      max_channels: 2
                      id: LvINTciHVoC017knMCH01y9pSi5OrDLCRaBPNDAoNJcmg
                      duration: 23.823792
                  status: ready
                  playback_ids:
                    - policy: public
                      id: vAFLI2eKFFicXX00iHBS2vqt5JjJGg5HV6fQ4Xijgt1I
                  mp4_support: none
                  max_stored_resolution: HD
                  resolution_tier: 1080p
                  max_stored_frame_rate: 29.97
                  master_access: none
                  id: lJ4bGGsp7ZlPf02nMg015W02iHQLN9XnuuLRBsPS00xqd68
                  duration: 23.857167
                  created_at: '1609868768'
                  updated_at: '1609869000'
                  aspect_ratio: '16:9'
                  passthrough: Example
  /video/v1/assets/{ASSET_ID}/input-info:
    get:
      tags:
        - video/v1 > assets > {ASSET_ID}
      summary: Retrieve asset input info
      description: >-
        Returns a list of the input objects that were used to create the asset
        along with any settings that were applied to each input.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - settings:
                      url: https://muxed.s3.amazonaws.com/leds.mp4
                    file:
                      container_format: mp4
                      tracks:
                        - type: video
                          duration: 120
                          width: 1280
                          height: 720
                          frame_rate: 30
                          encoding: h.264
                        - type: audio
                          duration: 120
                          sample_rate: 16000
                          sample_size: 24
                          encoding: aac
                  - settings:
                      url: https://example.com/myVideo_en.srt
                    file:
                      container_format: srt
  /video/v1/assets/{ASSET_ID}/mp4-support:
    put:
      tags:
        - video/v1 > assets > {ASSET_ID}
      summary: Update MP4 support
      description: >-
        Allows you to add or remove mp4 support for assets that were created
        without it. Currently there are two values supported in this request,
        `standard` and `none`. `none` means that an asset *does not* have mp4
        support, so submitting a request with `mp4_support` set to `none` will
        delete the mp4 assets from the asset in question.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                mp4_support: standard
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  tracks:
                    - type: video
                      max_width: 1920
                      max_height: 1080
                      max_frame_rate: 29.97
                      id: RiyQPM31a1SPtfI802bEP2zD02F5FQVNL801FRHeE5t01G4
                      duration: 23.8238
                    - type: audio
                      max_channels: 2
                      id: LvINTciHVoC017knMCH01y9pSi5OrDLCRaBPNDAoNJcmg
                      duration: 23.823792
                  status: ready
                  static_renditions:
                    status: preparing
                  playback_ids:
                    - policy: public
                      id: Lj02VZDorh9hCV00flNqPli8fmwf6KEppug01w8zDEYVlQ
                  mp4_support: standard
                  max_stored_resolution: HD
                  resolution_tier: 1080p
                  max_stored_frame_rate: 29.97
                  master_access: none
                  id: lJ4bGGsp7ZlPf02nMg015W02iHQLN9XnuuLRBsPS00xqd68
                  duration: 23.857167
                  created_at: '1609868768'
                  aspect_ratio: '16:9'
  /video/v1/assets/{ASSET_ID}/master-access:
    put:
      tags:
        - video/v1 > assets > {ASSET_ID}
      summary: Update master access
      description: >-
        Allows you to add temporary access to the master (highest-quality)
        version of the asset in MP4 format. A URL will be created that can be
        used to download the master version for 24 hours. After 24 hours Master
        Access will revert to "none".

        This master version is not optimized for web and not meant to be
        streamed, only downloaded for purposes like archiving or editing the
        video offline.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                master_access: temporary
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: ASSET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The asset ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  tracks:
                    - type: video
                      max_width: 1920
                      max_height: 1080
                      max_frame_rate: 29.97
                      id: RiyQPM31a1SPtfI802bEP2zD02F5FQVNL801FRHeE5t01G4
                      duration: 23.8238
                    - type: audio
                      max_channels: 2
                      id: LvINTciHVoC017knMCH01y9pSi5OrDLCRaBPNDAoNJcmg
                      duration: 23.823792
                  status: ready
                  playback_ids:
                    - policy: public
                      id: Lj02VZDorh9hCV00flNqPli8fmwf6KEppug01w8zDEYVlQ
                  mp4_support: none
                  max_stored_resolution: HD
                  resolution_tier: 1080p
                  max_stored_frame_rate: 29.97
                  master_access: temporary
                  master:
                    status: preparing
                  id: lJ4bGGsp7ZlPf02nMg015W02iHQLN9XnuuLRBsPS00xqd68
                  duration: 23.857167
                  created_at: '1609868768'
                  aspect_ratio: '16:9'
  /video/v1/assets:
    post:
      tags:
        - video/v1 > assets
      summary: Create an asset
      description: Create a new Mux Video asset.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                input:
                  - url: https://muxed.s3.amazonaws.com/leds.mp4
                playback_policy:
                  - public
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  status: preparing
                  playback_ids:
                    - policy: public
                      id: uNbxnGLKJ00yfbijDO8COxTOyVKT01xpxW
                  mp4_support: none
                  master_access: none
                  id: SqQnqz6s5MBuXGvJaUWdXuXM93J9Q2yv
                  created_at: '1607452572'
    get:
      tags:
        - video/v1 > assets
      summary: List assets
      description: List all Mux assets.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - tracks:
                      - type: video
                        max_width: 1920
                        max_height: 800
                        max_frame_rate: 24
                        id: HK01Bq7FrEQmIu3QpRiZZ98HQOOZjm6BYyg17eEunlyo
                        duration: 734.166667
                      - type: audio
                        max_channels: 2
                        id: nNKHJqw2G9cE019AoK16CJr3O27gGnbtW4w525hJWqWw
                        duration: 734.143991
                    status: ready
                    playback_ids:
                      - policy: public
                        id: 85g23gYz7NmQu02YsY81ihuod6cZMxCp017ZrfglyLCKc
                    mp4_support: none
                    max_stored_resolution: HD
                    resolution_tier: 1080p
                    max_stored_frame_rate: 24
                    master_access: none
                    id: 8jd7M77xQgf2NzuocJRPYdSdEfY5dLlcRwFARtgQqU4
                    duration: 734.25
                    created_at: '1609869152'
                    aspect_ratio: '12:5'
                  - tracks:
                      - type: video
                        max_width: 1920
                        max_height: 1080
                        max_frame_rate: 29.97
                        id: RiyQPM31a1SPtfI802bEP2zD02F5FQVNL801FRHeE5t01G4
                        duration: 23.8238
                      - type: audio
                        max_channels: 2
                        id: LvINTciHVoC017knMCH01y9pSi5OrDLCRaBPNDAoNJcmg
                        duration: 23.823792
                    status: ready
                    playback_ids:
                      - policy: public
                        id: vAFLI2eKFFicXX00iHBS2vqt5JjJGg5HV6fQ4Xijgt1I
                    mp4_support: none
                    max_stored_resolution: HD
                    resolution_tier: 1080p
                    max_stored_frame_rate: 29.97
                    master_access: none
                    id: lJ4bGGsp7ZlPf02nMg015W02iHQLN9XnuuLRBsPS00xqd68
                    duration: 23.857167
                    created_at: '1609868768'
                    aspect_ratio: '16:9'
  /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}:
    get:
      tags:
        - >-
          video/v1 > live-streams > {LIVE_STREAM_ID} > playback-ids >
          {PLAYBACK_ID}
      summary: Retrieve a live stream playback ID
      description: >-
        Fetches information about a live stream's playback ID, through which a
        viewer can watch the streamed content from this live stream.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: '{{muxStreamId}}'
        - name: PLAYBACK_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream's playback ID.
          example: '{{muxPlaybackId}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  policy: public
                  id: 4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw
    delete:
      tags:
        - >-
          video/v1 > live-streams > {LIVE_STREAM_ID} > playback-ids >
          {PLAYBACK_ID}
      summary: Delete a live stream playback ID
      description: >-
        Deletes the playback ID for the live stream. This will not disable
        ingest (as the live stream still exists). New attempts to play back the
        live stream will fail immediately. However, current viewers will be able
        to continue watching the stream for some period of time.
      parameters:
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: do ea cupidatat cillum ipsum
        - name: PLAYBACK_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream's playback ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids:
    post:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID} > playback-ids
      summary: Create a live stream playback ID
      description: >-
        Create a new playback ID for this live stream, through which a viewer
        can watch the streamed content of the live stream.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                policy: signed
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: do ea cupidatat cillum ipsum
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  policy: public
                  id: 4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw
  /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}:
    delete:
      tags:
        - >-
          video/v1 > live-streams > {LIVE_STREAM_ID} > simulcast-targets >
          {SIMULCAST_TARGET_ID}
      summary: Delete a Live Stream Simulcast Target
      description: >-
        Delete the simulcast target using the simulcast target ID returned when
        creating the simulcast target. Simulcast Target can only be deleted when
        the parent live stream is in idle state.
      parameters:
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: do ea cupidatat cillum ipsum
        - name: SIMULCAST_TARGET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the simulcast target.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
    get:
      tags:
        - >-
          video/v1 > live-streams > {LIVE_STREAM_ID} > simulcast-targets >
          {SIMULCAST_TARGET_ID}
      summary: Retrieve a Live Stream Simulcast Target
      description: >-
        Retrieves the details of the simulcast target created for the parent
        live stream. Supply the unique live stream ID and simulcast target ID
        that was returned in the response of create simulcast target request,
        and Mux will return the corresponding information.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: do ea cupidatat cillum ipsum
        - name: SIMULCAST_TARGET_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the simulcast target.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  url: rtmp://live.example.com/app
                  stream_key: abcdefgh
                  status: idle
                  passthrough: Example
                  id: 02FU00rPq00fC9S6kygrqlxygGMdpW1lk00BkFpCfc2kGregEIr7brt7CQ
  /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets:
    post:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID} > simulcast-targets
      summary: Create a live stream simulcast target
      description: >-
        Create a simulcast target for the parent live stream. Simulcast target
        can only be created when the parent live stream is in idle state. Only
        one simulcast target can be created at a time with this API.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                url: rtmp://live.example.com/app
                stream_key: abcdefgh
                passthrough: Example
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: do ea cupidatat cillum ipsum
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  url: rtmp://live.example.com/app
                  stream_key: abcdefgh
                  status: idle
                  passthrough: Example
                  id: le1axfGDc9ETqh6trHNTxGQ9XEhj02fOnX0200aAh24fwlmwzqKCYNJgw
  /video/v1/live-streams/{LIVE_STREAM_ID}:
    get:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID}
      summary: Retrieve a live stream
      description: >-
        Retrieves the details of a live stream that has previously been created.
        Supply the unique live stream ID that was returned from your previous
        request, and Mux will return the corresponding live stream information.
        The same information is returned when creating a live stream.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: '{{muxStreamId}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  stream_key: 831b5bde-cd8a-5bc4-115d-4ba34b19f481
                  status: idle
                  reconnect_window: 60
                  playback_ids:
                    - policy: public
                      id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                  new_asset_settings:
                    playback_policies:
                      - public
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  latency_mode: standard
                  max_continuous_duration: 43200
    delete:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID}
      summary: Delete a live stream
      description: >-
        Deletes a live stream from the current environment. If the live stream
        is currently active and being streamed to, ingest will be terminated and
        the encoder will be disconnected.
      parameters:
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
    patch:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID}
      summary: Update a live stream
      description: >-
        Updates the parameters of a previously-created live stream. This
        currently supports a subset of variables. Supply the live stream ID and
        the updated parameters and Mux will return the corresponding live stream
        information. The information returned will be the same after update as
        for subsequent get live stream requests.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                latency_mode: standard
                reconnect_window: 30
                max_continuous_duration: 1200
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: '{{muxStreamId}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  stream_key: 831b5bde-cd8a-5bc4-115d-4ba34b19f481
                  status: idle
                  reconnect_window: 30
                  playback_ids:
                    - policy: public
                      id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                  new_asset_settings:
                    playback_policies:
                      - public
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  latency_mode: standard
                  max_continuous_duration: 1200
  /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key:
    post:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID}
      summary: Reset a live stream's stream key
      description: >-
        Reset a live stream key if you want to immediately stop the current
        stream key from working and create a new stream key that can be used for
        future broadcasts.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: do ea cupidatat cillum ipsum
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  stream_key: acaf2ca1-ba9c-5ffe-8c9c-a02bbf0009a6
                  status: idle
                  reconnect_window: 60
                  playback_ids:
                    - policy: public
                      id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                    - policy: public
                      id: 4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw
                  new_asset_settings:
                    playback_policies:
                      - public
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  latency_mode: standard
                  max_continuous_duration: 43200
  /video/v1/live-streams/{LIVE_STREAM_ID}/complete:
    put:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID}
      summary: Signal a live stream is finished
      description: >
        (Optional) End the live stream recording immediately instead of waiting
        for the reconnect_window. `EXT-X-ENDLIST` tag is added to the HLS
        manifest which notifies the player that this live stream is over.


        Mux does not close the encoder connection immediately. Encoders are
        often configured to re-establish connections immediately which would
        result in a new recorded asset. For this reason, Mux waits for 60s
        before closing the connection with the encoder. This 60s timeframe is
        meant to give encoder operators a chance to disconnect from their end.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: '{{muxStreamId}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data: {}
  /video/v1/live-streams/{LIVE_STREAM_ID}/disable:
    put:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID}
      summary: Disable a live stream
      description: >
        Disables a live stream, making it reject incoming RTMP streams until
        re-enabled. The API also ends the live stream recording immediately when
        active. Ending the live stream recording adds the `EXT-X-ENDLIST` tag to
        the HLS manifest which notifies the player that this live stream is
        over.


        Mux also closes the encoder connection immediately. Any attempt from the
        encoder to re-establish connection will fail till the live stream is
        re-enabled.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data: {}
  /video/v1/live-streams/{LIVE_STREAM_ID}/enable:
    put:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID}
      summary: Enable a live stream
      description: Enables a live stream, allowing it to accept an incoming RTMP stream.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: '{{muxStreamId}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data: {}
  /video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles:
    put:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID}
      summary: Update a live stream's embedded subtitles
      description: >
        Configures a live stream to receive embedded closed captions.

        The resulting Asset's subtitle text track will have `closed_captions:
        true` set.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                embedded_subtitles:
                  - passthrough: Example
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  stream_key: acaf2ca1-ba9c-5ffe-8c9c-a02bbf0009a6
                  status: idle
                  reconnect_window: 60
                  playback_ids:
                    - policy: public
                      id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                    - policy: public
                      id: 4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw
                  new_asset_settings:
                    playback_policies:
                      - public
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  embedded_subtitles:
                    - name: English CC
                      language_code: en
                      language_channel: cc1
                      passthrough: Example
                  latency_mode: standard
                  max_continuous_duration: 43200
  /video/v1/live-streams/{LIVE_STREAM_ID}/generated-subtitles:
    put:
      tags:
        - video/v1 > live-streams > {LIVE_STREAM_ID}
      summary: Update a live stream's generated subtitles
      description: >
        Updates a live stream's automatic-speech-recognition-generated subtitle
        configuration.

        Automatic speech recognition subtitles can be removed by sending an
        empty array in the

        request payload.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                generated_subtitles:
                  - name: English CC (ASR)
                    language: en
                    passthrough: Example
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: LIVE_STREAM_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream ID
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  stream_key: acaf2ca1-ba9c-5ffe-8c9c-a02bbf0009a6
                  status: idle
                  reconnect_window: 60
                  playback_ids:
                    - policy: public
                      id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                    - policy: public
                      id: 4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw
                  new_asset_settings:
                    playback_policies:
                      - public
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  generated_subtitles:
                    - name: English CC (ASR)
                      language_code: en
                      passthrough: Example
  /video/v1/live-streams:
    post:
      tags:
        - video/v1 > live-streams
      summary: Create a live stream
      description: >-
        Creates a new live stream. Once created, an encoder can connect to Mux
        via the specified stream key and begin streaming to an audience.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                playback_policy:
                  - public
                new_asset_settings:
                  playback_policy:
                    - public
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  stream_key: abcdefgh
                  status: idle
                  reconnect_window: 60
                  playback_ids:
                    - policy: public
                      id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                  new_asset_settings:
                    playback_policies:
                      - public
                  id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                  created_at: '1609937654'
                  latency_mode: standard
                  max_continuous_duration: 43200
    get:
      tags:
        - video/v1 > live-streams
      summary: List live streams
      description: Lists the live streams that currently exist in the current environment.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: stream_key
          in: query
          schema:
            type: string
          description: Filter response to return live stream for this stream key only
          example: '{{muxStreamKey}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - stream_key: 831b5bde-cd8a-5bc4-115d-4ba34b19f481
                    status: idle
                    reconnect_window: 60
                    playback_ids:
                      - policy: public
                        id: HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018
                    new_asset_settings:
                      playback_policies:
                        - public
                    id: ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag
                    created_at: '1609937654'
                    latency_mode: standard
                    max_continuous_duration: 43200
                  - stream_key: d273c65e-1fc8-27dc-e9ef-56144cbceb3a
                    status: idle
                    reconnect_window: 60
                    recent_asset_ids:
                      - SZs02xxHgYdkHp00OSCjJiHUHqzVQZNU332XPXRxe341o
                      - e4J9cwb5tjVxMeeV8201dC00i800ThPKKGT2SEN002dHH2s
                    playback_ids:
                      - policy: public
                        id: 00zOcribkUmXqXHzBTpflk2771BRTcKATqPjWf7JHpuM
                    new_asset_settings:
                      playback_policies:
                        - public
                    id: B65hEUWW01ErVKDDGImKcBquYhwEAkjW6Ic3lPY0299Cc
                    created_at: '1607587513'
                    latency_mode: standard
                    max_continuous_duration: 43200
  /video/v1/signing-keys/{SIGNING_KEY_ID}:
    get:
      tags:
        - video/v1 > signing-keys > {SIGNING_KEY_ID}
      summary: Retrieve a URL signing key
      description: >
        This route is now deprecated, please use the `Signing Keys` API.
        Retrieves the details of a URL signing key that has previously

        been created. Supply the unique signing key ID that was returned from
        your

        previous request, and Mux will return the corresponding signing key
        information.

        **The private key is not returned in this response.**


        Note: Any new access tokens authenticating this route will be required
        to have `System` level permissions.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: SIGNING_KEY_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the signing key.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: jc6lJiCLMjyC202EXtRQ644sShzDv6x5tWJrbvUFpvmo
                  created_at: '1608632647'
    delete:
      tags:
        - video/v1 > signing-keys > {SIGNING_KEY_ID}
      summary: Delete a URL signing key
      description: >
        This route is now deprecated, please use the `Signing Keys` API. Deletes
        an existing signing key. Use with caution, as this will

        invalidate any existing signatures and no URLs can be signed using the
        key

        again.


        Note: Any new access tokens authenticating this route will be required
        to have `System` level permissions.
      parameters:
        - name: SIGNING_KEY_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the signing key.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /video/v1/signing-keys:
    post:
      tags:
        - video/v1 > signing-keys
      summary: Create a URL signing key
      description: >
        This route is now deprecated, please use the `Signing Keys` API. Creates
        a new signing key pair. When creating a new signing key,

        the API will generate a 2048-bit RSA key-pair and return the private key
        and

        a generated key-id; the public key will be stored at Mux to validate
        signed

        tokens.


        Note: Any new access tokens authenticating this route will be required
        to have `System` level permissions.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  private_key: abcd123=
                  id: vI5KTQ78ohYriuvWKHY6COtZWXexHGLllxksOdZuya8
                  created_at: '1610108345'
    get:
      tags:
        - video/v1 > signing-keys
      summary: List URL signing keys
      description: >
        This route is now deprecated, please use the `Signing Keys` API. Returns
        a list of URL signing keys.


        Note: Any new access tokens authenticating this route will be required
        to have `System` level permissions.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - id: vI5KTQ78ohYriuvWKHY6COtZWXexHGLllxksOdZuya8
                    created_at: '1610108345'
                  - id: jc6lJiCLMjyC202EXtRQ644sShzDv6x5tWJrbvUFpvmo
                    created_at: '1608632647'
  /video/v1/uploads/{UPLOAD_ID}:
    get:
      tags:
        - video/v1 > uploads > {UPLOAD_ID}
      summary: Retrieve a single direct upload's info
      description: >-
        Fetches information about a single direct upload in the current
        environment.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: UPLOAD_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Upload
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  timeout: 3600
                  status: asset_created
                  new_asset_settings:
                    playback_policies:
                      - public
                    mp4_support: standard
                  id: YzoCL01HHOtAVYq4Ds9zekdHJ2XqL9e8ukPWbr01KhtvM
                  asset_id: AnFVqAVXfb7vVL3ypSQDMnJZunnb8nkwe02O00p2gK8P00
  /video/v1/uploads/{UPLOAD_ID}/cancel:
    put:
      tags:
        - video/v1 > uploads > {UPLOAD_ID}
      summary: Cancel a direct upload
      description: >
        Cancels a direct upload and marks it as cancelled. If a pending upload
        finishes after this

        request, no asset will be created. This request will only succeed if the
        upload is still in

        the `waiting` state.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: UPLOAD_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Upload
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  timeout: 3600
                  status: cancelled
                  new_asset_settings:
                    playback_policies:
                      - public
                    mp4_support: standard
                  id: zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc
                  cors_origin: https://example.com/
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /video/v1/uploads:
    post:
      tags:
        - video/v1 > uploads
      summary: Create a new direct upload URL
      description: >-
        Creates a new direct upload, through which video content can be uploaded
        for ingest to Mux.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                cors_origin: https://example.com/
                new_asset_settings:
                  playback_policy:
                    - public
                  mp4_support: standard
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  url: >-
                    https://storage.googleapis.com/video-storage-us-east1-uploads/zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc?Expires=1610112458&GoogleAccessId=mux-direct-upload%40mux-cloud.iam.gserviceaccount.com&Signature=LCu4PMoKUo%2BJkWQAUwB9WU4bWVVfW3K5bZxSxEptBz3DrjbFxNyGvs0sriyJupZh9Jdb6FxKWFIRbxEetfnAAiesOvSPH%2F1GlIichmGg3YfebfxiX77%2B6ToFF6FMkJucBo284PD90AVLHhKagOea2VsbdO0fh78MAxGH9sEspyQ2uJEfYWjHFqYQ9smJyIuM3CYOmN5HKPgRWy2yUqzV7OTMe%2FivPO4%2FX6XiiN2J4nTmy83252CJUsHIvbiGctfKxcNI6b23UVN4B1tJTVgyxTOZiBQCkMLkD%2FEe5OhoAkvJgkqENRr0q3swO0IChDDWjrh7OTMwqvWGwAoVXEGiHg%3D%3D&upload_id=ABg5-UznTdib1HhOAMjdHhWIYqBbwmSYM6dVKyPe3v33uTeEE8gkN5QzvR3cei6uSZOSrjPn7bdvvDH3nhsrLBq8AjWY2qE4UQ
                  timeout: 3600
                  status: waiting
                  new_asset_settings:
                    playback_policies:
                      - public
                    mp4_support: standard
                  id: zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc
                  cors_origin: https://example.com/
    get:
      tags:
        - video/v1 > uploads
      summary: List direct uploads
      description: Lists direct uploads in the current environment.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - url: >-
                      https://storage.googleapis.com/video-storage-us-east1-uploads/zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc?Expires=1610112458&GoogleAccessId=mux-direct-upload%40mux-cloud.iam.gserviceaccount.com&Signature=LCu4PMoKUo%2BJkWQAUwB9WU4bWVVfW3K5bZxSxEptBz3DrjbFxNyGvs0sriyJupZh9Jdb6FxKWFIRbxEetfnAAiesOvSPH%2F1GlIichmGg3YfebfxiX77%2B6ToFF6FMkJucBo284PD90AVLHhKagOea2VsbdO0fh78MAxGH9sEspyQ2uJEfYWjHFqYQ9smJyIuM3CYOmN5HKPgRWy2yUqzV7OTMe%2FivPO4%2FX6XiiN2J4nTmy83252CJUsHIvbiGctfKxcNI6b23UVN4B1tJTVgyxTOZiBQCkMLkD%2FEe5OhoAkvJgkqENRr0q3swO0IChDDWjrh7OTMwqvWGwAoVXEGiHg%3D%3D&upload_id=ABg5-UznTdib1HhOAMjdHhWIYqBbwmSYM6dVKyPe3v33uTeEE8gkN5QzvR3cei6uSZOSrjPn7bdvvDH3nhsrLBq8AjWY2qE4UQ
                    timeout: 3600
                    status: waiting
                    new_asset_settings:
                      playback_policies:
                        - public
                      mp4_support: standard
                    id: zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc
                    cors_origin: https://example.com/
                  - timeout: 3600
                    status: asset_created
                    new_asset_settings:
                      playback_policies:
                        - public
                      mp4_support: standard
                    id: YzoCL01HHOtAVYq4Ds9zekdHJ2XqL9e8ukPWbr01KhtvM
                    asset_id: AnFVqAVXfb7vVL3ypSQDMnJZunnb8nkwe02O00p2gK8P00
                  - timeout: 10800
                    status: cancelled
                    new_asset_settings:
                      playback_policies:
                        - public
                      mp4_support: standard
                    id: AZcWu0201SqVW01LMdmVxE00m3gEWUFZPItvni1sTqF800dQ
  /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}:
    delete:
      tags:
        - video/v1 > playback-restrictions > {PLAYBACK_RESTRICTION_ID}
      summary: Delete a Playback Restriction
      description: Deletes a single Playback Restriction.
      parameters:
        - name: PLAYBACK_RESTRICTION_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Playback Restriction.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
    get:
      tags:
        - video/v1 > playback-restrictions > {PLAYBACK_RESTRICTION_ID}
      summary: Retrieve a Playback Restriction
      description: Retrieves a Playback Restriction associated with the unique identifier.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: PLAYBACK_RESTRICTION_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Playback Restriction.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: 9dbEg8o00uqQzZbzJT6NXdqNA00SdnSo8O
                  updated_at: '1607945257'
                  created_at: '1607939184'
                  referrer:
                    allowed_domains:
                      - '*.example.com'
                    allow_no_referrer: false
  /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer:
    put:
      tags:
        - video/v1 > playback-restrictions > {PLAYBACK_RESTRICTION_ID}
      summary: Update the Referrer Playback Restriction
      description: >-
        Allows you to modify the list of domains or change how Mux validates
        playback requests without the `Referer` HTTP header. The Referrer
        restriction fully replaces the old list with this new list of domains.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                allowed_domains:
                  - '*.example.com'
                allow_no_referrer: true
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: PLAYBACK_RESTRICTION_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Playback Restriction.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: 9dbEg8o00uqQzZbzJT6NXdqNA00SdnSo8O
                  updated_at: '1607945257'
                  created_at: '1607939184'
                  referrer:
                    allowed_domains:
                      - '*.example.com'
                    allow_no_referrer: true
  /video/v1/playback-restrictions:
    post:
      tags:
        - video/v1 > playback-restrictions
      summary: Create a Playback Restriction
      description: Create a new Playback Restriction.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                referrer:
                  allowed_domains:
                    - '*.example.com'
                  allow_no_referrer: true
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: 9dbEg8o00uqQzZbzJT6NXdqNA00SdnSo8O
                  updated_at: '1607945257'
                  created_at: '1607945257'
                  referrer:
                    allowed_domains:
                      - '*.example.com'
                    allow_no_referrer: true
    get:
      tags:
        - video/v1 > playback-restrictions
      summary: List Playback Restrictions
      description: Returns a list of all Playback Restrictions.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 2
                page: 1
                limit: 100
                data:
                  - id: 9dbEg8o00uqQzZbzJT6NXdqNA00SdnSo8O
                    updated_at: '1607945257'
                    created_at: '1607939184'
                    referrer:
                      allowed_domains:
                        - '*.example.com'
                      allow_no_referrer: false
                  - id: 012uTQqPygDYWz3jey8cyOX9n01Bd5SDH1
                    updated_at: '1607945980'
                    created_at: '1607939188'
                    referrer:
                      allowed_domains:
                        - a.example.com
                        - b.example.com
                      allow_no_referrer: true
  /video/v1/playback-ids/{PLAYBACK_ID}:
    get:
      tags:
        - video/v1
      summary: Retrieve an Asset or Live Stream ID
      description: >-
        Retrieves the Identifier of the Asset or Live Stream associated with the
        Playback ID.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: PLAYBACK_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The live stream's playback ID.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: a1B2c3D4e5F6g7H8i9
                  policy: public
                  object:
                    type: asset
                    id: '123456789012345678'
  /video/v1/delivery-usage:
    get:
      tags:
        - video/v1
      summary: List Usage
      description: >-
        Returns a list of delivery usage records and their associated Asset IDs
        or Live Stream IDs.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 2
                timeframe:
                  - 1607817600
                  - 1607990400
                page: 1
                limit: 100
                data:
                  - live_stream_id: B65hEUWW01ErVKDDGImKcBquYhwEAkjW6Ic3lPY0299Cc
                    delivered_seconds: 206.366667
                    delivered_seconds_by_resolution:
                      tier_1080p: 100
                      tier_720p: 100
                      tier_audio_only: 6.366667
                    deleted_at: '1607945257'
                    created_at: '1607939184'
                    asset_state: deleted
                    asset_id: Ww4v2q2H4MNbHIAM2wApKb3cmrh7eHjGLUjdKohR5wM
                    asset_duration: 154.366667
                  - delivered_seconds: 30
                    delivered_seconds_by_resolution:
                      tier_1080p: 10
                      tier_720p: 10
                      tier_audio_only: 10
                    deleted_at: '1607935288'
                    created_at: '1607617107'
                    asset_state: deleted
                    asset_id: Qlb007on1TwN43XLIG027QJlUxm3jd01v5PRi1aXhnyFZY
                    asset_duration: 98.773667
  /data/v1/video-views:
    get:
      tags:
        - data/v1 > video-views
      summary: List Video Views
      description: >-
        Returns a list of video views which match the filters and have a
        `view_end` within the specified timeframe.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 4
                timeframe:
                  - 1610025789
                  - 1610112189
                data:
                  - viewer_os_family: OS X
                    viewer_application_name: Chrome
                    view_start: '2021-01-07T20:34:06Z'
                    view_end: '2021-01-07T20:46:04Z'
                    video_title: my-title
                    total_row_count: 4
                    player_error_message: null
                    player_error_code: null
                    id: JpA81zBfGaGZ85C6aGF3bptyD4CKwpdNgamr
                    error_type_id: 1
                    country_code: US
                  - viewer_os_family: OS X
                    viewer_application_name: Chrome
                    view_start: '2021-01-07T20:21:53Z'
                    view_end: '2021-01-07T20:34:03Z'
                    video_title: ''
                    total_row_count: 4
                    player_error_message: null
                    player_error_code: null
                    id: jPVLR5giYMrLYbHM88Tkn3cM3qCRDk0jL114
                    error_type_id: 1
                    country_code: US
                  - viewer_os_family: OS X
                    viewer_application_name: Chrome
                    view_start: '2021-01-07T15:16:06Z'
                    view_end: '2021-01-07T15:17:06Z'
                    video_title: Video Test Title 12.14.20
                    total_row_count: 4
                    player_error_message: this is an error message from the player
                    player_error_code: '1001'
                    id: pdLDVKBuPZJJ9YsPVmtmB9FG9gsWBWMmYar4
                    error_type_id: 1
                    country_code: US
                  - viewer_os_family: OS X
                    viewer_application_name: Chrome
                    view_start: '2021-01-07T15:15:09Z'
                    view_end: '2021-01-07T15:15:17Z'
                    video_title: Video Test Title 12.14.20
                    total_row_count: 4
                    player_error_message: null
                    player_error_code: null
                    id: zbZPowWtD3z54jcGMLCJJpF79zCjB03bV7o8
                    error_type_id: 1
                    country_code: US
  /data/v1/video-views/{VIDEO_VIEW_ID}:
    get:
      tags:
        - data/v1 > video-views
      summary: Get a Video View
      description: Returns the details of a video view.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: VIDEO_VIEW_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Video View
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: null
                timeframe:
                  - 1643133378
                  - 1643219778
                data:
                  view_end: '2022-01-26T17:56:12Z'
                  viewer_device_model: iPhone10,4
                  viewer_os_version: '15.1'
                  video_id: rmp7fvw5lPD01l8PZ2aN74js84XrTWxHy
                  view_playing_time: '58134'
                  exit_before_video_start: false
                  player_mux_plugin_name: apple-mux
                  view_max_downscale_percentage: '0.32222223'
                  country_name: United States
                  view_id: 8d00a0ca-8456-4e55-9ff8-dc501814a6b1
                  view_start: '2022-01-26T17:08:18Z'
                  view_max_playhead_position: '41126'
                  player_source_host_name: stream.mux.com
                  player_error_code: '1001'
                  player_error_message: error from player
                  player_source_url: https://stream.mux.com/ax9qwyTIaUDLdmhesYDKir5kfE4Ve215.m3u8
                  city: Austin
                  view_max_upscale_percentage: '0'
                  asset_id: rmp7fvw5lPD01l8PZ2aN74js84XrTWxHy
                  events:
                    - viewer_time: 1643216891851
                      playback_time: 0
                      name: playerready
                      event_time: 1643216898061
                    - viewer_time: 1643216891853
                      playback_time: 0
                      name: viewstart
                      event_time: 1643216898101
                  view_total_content_playback_time: 37521
                  asn: 11427
                  weighted_average_bitrate: 697078
  /data/v1/filters:
    get:
      tags:
        - data/v1 > filters
      summary: List Filters
      description: |
        The API has been replaced by the list-dimensions API call.

        Lists all the filters broken out into basic and advanced.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 1
                timeframe:
                  - 1610027251
                  - 1610113651
                data:
                  basic:
                    - browser
                    - operating_system
                    - player_remote_played
                    - player_software
                    - player_software_version
                    - player_mux_plugin_name
                    - player_mux_plugin_version
                    - player_autoplay
                    - player_preload
                    - video_title
                    - video_id
                    - stream_type
                    - source_type
                    - source_hostname
                    - continent_code
                    - country
                    - player_error_code
                    - asset_id
                    - live_stream_id
                    - playback_id
                    - view_drm_type
                    - view_has_ad
                    - custom_1
                    - custom_2
                    - custom_3
                    - custom_4
                    - custom_5
                    - custom_6
                    - custom_7
                    - custom_8
                    - custom_9
                    - custom_10
                  advanced:
                    - browser_version
                    - operating_system_version
                    - viewer_device_name
                    - viewer_device_model
                    - viewer_device_category
                    - viewer_device_manufacturer
                    - player_name
                    - player_version
                    - video_series
                    - video_encoding_variant
                    - experiment_name
                    - sub_property_id
                    - asn
                    - cdn
                    - viewer_connection_type
                    - view_session_id
                    - region
                    - viewer_user_id
                    - exit_before_video_start
                    - video_startup_failure
                    - preroll_ad_asset_hostname
                    - preroll_ad_tag_hostname
                    - preroll_played
                    - preroll_requested
  /data/v1/filters/{FILTER_ID}:
    get:
      tags:
        - data/v1 > filters
      summary: Lists values for a specific filter
      description: |
        The API has been replaced by the list-dimension-values API call.

        Lists the values for a filter along with a total count of related views.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: FILTER_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Filter
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 1
                timeframe:
                  - 1610028123
                  - 1610114523
                data:
                  - value: Chrome
                    total_count: 5
  /data/v1/dimensions:
    get:
      tags:
        - data/v1 > dimensions
      summary: List Dimensions
      description: |
        List all available dimensions.

        Note: This API replaces the list-filters API call.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  advanced:
                    - browser_version
                    - operating_system_version
                    - viewer_device_name
                    - viewer_device_model
                    - viewer_device_category
                    - viewer_device_manufacturer
                    - player_name
                    - player_version
                    - video_series
                    - video_encoding_variant
                    - experiment_name
                    - sub_property_id
                    - asn
                    - cdn
                    - viewer_connection_type
                    - view_session_id
                    - region
                    - viewer_user_id
                    - exit_before_video_start
                    - video_startup_failure
                    - preroll_ad_asset_hostname
                    - preroll_ad_tag_hostname
                    - preroll_played
                    - preroll_requested
                  basic:
                    - browser
                    - operating_system
                    - player_remote_played
                    - player_software
                    - player_software_version
                    - player_mux_plugin_name
                    - player_mux_plugin_version
                    - player_autoplay
                    - player_preload
                    - video_title
                    - video_id
                    - stream_type
                    - source_type
                    - source_hostname
                    - continent_code
                    - country
                    - player_error_code
                    - asset_id
                    - live_stream_id
                    - playback_id
                    - view_drm_type
                    - view_has_ad
                    - custom_1
                    - custom_2
                    - custom_3
                    - custom_4
                    - custom_5
                    - custom_6
                    - custom_7
                    - custom_8
                    - custom_9
                    - custom_10
                timeframe:
                  - 1610033879
                  - 1610120279
                total_row_count: 1
  /data/v1/dimensions/{DIMENSION_ID}:
    get:
      tags:
        - data/v1 > dimensions
      summary: Lists the values for a specific dimension
      description: >
        Lists the values for a dimension along with a total count of related
        views.


        Note: This API replaces the list-filter-values API call.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: DIMENSION_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Dimension
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - total_count: 10000
                    value: FR
                  - total_count: 5000
                    value: ES
                  - total_count: 2000
                    value: PT
                  - total_count: 100
                    value: DE
                  - total_count: 1
                    value: BE
                timeframe:
                  - 1610033976
                  - 1610120376
                total_row_count: 5
  /data/v1/exports:
    get:
      tags:
        - data/v1 > exports
      summary: List property video view export links
      description: |
        The API has been replaced by the list-exports-views API call.

        Lists the available video view exports along with URLs to retrieve them.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 10
                timeframe:
                  - 1610024528
                  - 1610110928
                data:
                  - >-
                    https://s3.amazonaws.com/mux-data-exports/1/2021_01_01.csv.gz?...signature...
                  - >-
                    https://s3.amazonaws.com/mux-data-exports/1/2021_01_02.csv.gz?...signature...
                  - >-
                    https://s3.amazonaws.com/mux-data-exports/1/2021_01_03.csv.gz?...signature...
  /data/v1/exports/views:
    get:
      tags:
        - data/v1 > exports
      summary: List available property view exports
      description: Lists the available video view exports along with URLs to retrieve them.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 7
                timeframe:
                  - 1626296941
                  - 1626383341
                data:
                  - files:
                      - version: 2
                        type: csv
                        path: >-
                          https://s3.amazonaws.com/mux-data-exports/1/2021_01_03.csv.gz?...signature...
                    export_date: '2021-01-03'
                  - files:
                      - version: 2
                        type: csv
                        path: >-
                          https://s3.amazonaws.com/mux-data-exports/1/2021_01_02.csv.gz?...signature...
                    export_date: '2021-01-02'
                  - files:
                      - version: 2
                        type: csv
                        path: >-
                          https://s3.amazonaws.com/mux-data-exports/1/2021_01_01.csv.gz?...signature...
                    export_date: '2021-01-01'
  /data/v1/metrics/{METRIC_ID}/breakdown:
    get:
      tags:
        - data/v1 > metrics > {METRIC_ID}
      summary: List breakdown values
      description: List the breakdown values for a specific metric.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Metric
          example: video_startup_time
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 1
                timeframe:
                  - 1610028298
                  - 1610114698
                meta:
                  aggregation: view_end
                data:
                  - views: 5
                    value: 4
                    total_watch_time: 513934
                    total_playing_time: 413934
                    negative_impact: 1
                    field: US
  /data/v1/metrics/{METRIC_ID}/overall:
    get:
      tags:
        - data/v1 > metrics > {METRIC_ID}
      summary: Get Overall values
      description: >-
        Returns the overall value for a specific metric, as well as the total
        view count, watch time, and the Mux Global metric value for the metric.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Metric
          example: video_startup_time
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 1
                timeframe:
                  - 1610029525
                  - 1610115925
                meta:
                  aggregation: view_end
                data:
                  value: 4
                  total_watch_time: 513934
                  total_playing_time: 413934
                  total_views: 5
                  global_value: 1169.1832095168065
  /data/v1/metrics/{METRIC_ID}/insights:
    get:
      tags:
        - data/v1 > metrics > {METRIC_ID}
      summary: List Insights
      description: >-
        Returns a list of insights for a metric. These are the worst performing
        values across all breakdowns sorted by how much they negatively impact a
        specific metric.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Metric
          example: video_startup_time
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 18
                timeframe:
                  - 1610029610
                  - 1610116010
                meta:
                  aggregation: view_end
                data:
                  - total_watch_time: 351144
                    total_playing_time: 341144
                    total_views: 1
                    negative_impact_score: -5
                    metric: 9
                    filter_value: ''
                    filter_column: video_title
                  - total_watch_time: 513934
                    total_views: 5
                    negative_impact_score: 0
                    metric: 4
                    filter_value: US
                    filter_column: country
  /data/v1/metrics/{METRIC_ID}/timeseries:
    get:
      tags:
        - data/v1 > metrics > {METRIC_ID}
      summary: Get metric timeseries data
      description: >
        Returns timeseries data for a specific metric.


        Each interval represented in the data array contains an array with the
        following values:
          * the first element is the interval time
          * the second element is the calculated metric value
          * the third element is the number of views in the interval that have a valid metric value
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Metric
          example: video_startup_time
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 2
                timeframe:
                  - 1610029711
                  - 1610116111
                meta:
                  aggregation: view_end
                data:
                  - - '2021-01-07T14:00:00Z'
                    - '0.8743536882994202'
                    - '154240'
                  - - '2021-01-07T15:00:00Z'
                    - '0.8929105055911401'
                    - '156056'
  /data/v1/metrics/comparison:
    get:
      tags:
        - data/v1 > metrics
      summary: List all metric values
      description: List all of the values across every breakdown for a specific metric.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 1
                timeframe:
                  - 1610029906
                  - 1610116306
                data:
                  - watch_time: 513934
                    view_count: 5
                    started_views: 6
                    ended_views: 5
                    unique_viewers: 6
                    total_playing_time: 503934
                    name: totals
                  - value: 6
                    type: number
                    name: Views
                    metric: views
                    items:
                      - value: 6
                        type: number
                        name: Unique Viewers
                        metric: unique_viewers
                      - value: 503934
                        type: milliseconds
                        name: Playing Time
                        metric: playing_time
                  - value: 0.7803472280502319
                    type: score
                    name: Overall Score
                    metric: viewer_experience_score
                  - value: 0.8
                    type: score
                    name: Playback Failure Score
                    metric: playback_failure_score
                    items:
                      - value: 0.2
                        type: percentage
                        name: Playback Failure Percentage
                        metric: playback_failure_percentage
                      - value: 0
                        type: percentage
                        name: Video Startup Failure Percentage
                        metric: video_startup_failure_percentage
                  - value: 0.9991008877754212
                    type: score
                    name: Startup Time Score
                    metric: startup_time_score
                    items:
                      - value: 4
                        type: milliseconds
                        name: Video Startup Time (median)
                        metric: video_startup_time
                        measurement: median
                      - value: 9
                        type: milliseconds
                        name: Video Startup Time (95th %)
                        metric: video_startup_time
                        measurement: 95th
                      - value: 52.5625
                        type: milliseconds
                        name: Player Startup Time (median)
                        metric: player_startup_time
                        measurement: median
                      - value: 60.0625
                        type: milliseconds
                        name: Player Startup Time (95th %)
                        metric: player_startup_time
                        measurement: 95th
                      - value: 122.37890625
                        type: milliseconds
                        name: Page Load Time (median)
                        metric: page_load_time
                        measurement: median
                      - value: 264.0625
                        type: milliseconds
                        name: Page Load Time (95th %)
                        metric: page_load_time
                        measurement: 95th
                      - value: 182.25
                        type: milliseconds
                        name: Aggregate Startup Time (median)
                        metric: aggregate_startup_time
                        measurement: median
                      - value: 319.515625
                        type: milliseconds
                        name: Aggregate Startup Time (95th %)
                        metric: aggregate_startup_time
                        measurement: 95th
                      - value: 3042
                        type: milliseconds
                        name: Seek Latency
                        metric: seek_latency
                      - value: 0
                        type: percentage
                        name: Exits Before Video Start
                        metric: exits_before_video_start
                  - value: 0.9523247838020324
                    type: score
                    name: Rebuffer Score
                    metric: rebuffer_score
                    items:
                      - value: 0.0005564916895943838
                        type: percentage
                        name: Rebuffer Percentage
                        metric: rebuffer_percentage
                      - value: 0.11674650830651406
                        type: per_minute
                        name: Rebuffer Frequency
                        metric: rebuffer_frequency
                      - value: 0
                        type: milliseconds
                        name: Rebuffer Duration (median)
                        metric: rebuffer_duration
                        measurement: median
                      - value: 256
                        type: milliseconds
                        name: Rebuffer Duration (95th %)
                        metric: rebuffer_duration
                        measurement: 95th
                      - value: 0
                        type: number
                        name: Rebuffer Count (median)
                        metric: rebuffer_count
                        measurement: median
                      - value: 1
                        type: number
                        name: Rebuffer Count (95th %)
                        metric: rebuffer_count
                        measurement: 95th
                  - value: 1
                    type: score
                    name: Video Quality Score
                    metric: video_quality_score
                    items:
                      - value: 0
                        type: percentage
                        name: Upscale Percentage (median)
                        metric: upscale_percentage
                        measurement: median
                      - value: 0
                        type: percentage
                        name: Upscale Percentage (95th %)
                        metric: upscale_percentage
                        measurement: 95th
                      - value: 0
                        type: percentage
                        name: Upscale Percentage (average)
                        metric: upscale_percentage
                        measurement: avg
                      - value: 0.007
                        type: percentage
                        name: Downscale Percentage (median)
                        metric: downscale_percentage
                        measurement: median
                      - value: 0.449
                        type: percentage
                        name: Downscale Percentage (95th %)
                        metric: downscale_percentage
                        measurement: 95th
                      - value: 0.11813909473676262
                        type: percentage
                        name: Downscale Percentage (average)
                        metric: downscale_percentage
                        measurement: avg
                      - value: 0
                        type: percentage
                        name: Max Upscale Percentage (median)
                        metric: max_upscale_percentage
                        measurement: median
                      - value: 0
                        type: percentage
                        name: Max Upscale Percentage (95th %)
                        metric: max_upscale_percentage
                        measurement: 95th
                      - value: 0.007
                        type: percentage
                        name: Max Downscale Percentage (median)
                        metric: max_downscale_percentage
                        measurement: median
                      - value: 0.449
                        type: percentage
                        name: Max Downscale Percentage (95th %)
                        metric: max_downscale_percentage
                        measurement: 95th
                      - value: 851582.91015625
                        type: mbps
                        name: Weighted Average Bitrate (median)
                        metric: weighted_average_bitrate
                        measurement: median
                      - value: 697016.265625
                        type: mbps
                        name: Weighted Average Bitrate (95th %)
                        metric: weighted_average_bitrate
                        measurement: 95th
                      - value: 2195
                        type: milliseconds
                        name: Live Stream Latency (median)
                        metric: live_stream_latency
                        measurement: median
                      - value: 3523
                        type: milliseconds
                        name: Live Stream Latency (95th %)
                        metric: live_stream_latency
                        measurement: 95th
  /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown:
    get:
      tags:
        - data/v1 > monitoring > metrics > {MONITORING_METRIC_ID}
      summary: Get Monitoring Breakdown
      description: >-
        Gets breakdown information for a specific dimension and metric along
        with the number of concurrent viewers and negative impact score.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: MONITORING_METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Monitoring Metric
          example: current-concurrent-viewers
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - concurrent_viewers: 2680
                    metric_value: 0.008195679660675846
                    negative_impact: 1
                    value: FR
                  - concurrent_viewers: 36
                    metric_value: 0.010317417106767573
                    negative_impact: 4
                    value: ES
                  - concurrent_viewers: 30
                    metric_value: 0.06408818534303201
                    negative_impact: 2
                    value: RE
                  - concurrent_viewers: 26
                    metric_value: 0.008232510579858339
                    negative_impact: 7
                    value: GB
                  - concurrent_viewers: 10
                    metric_value: 0
                    negative_impact: 26
                    value: BE
                timeframe:
                  - 1610121421
                  - 1610121421
                total_row_count: 1
  /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries:
    get:
      tags:
        - data/v1 > monitoring > metrics > {MONITORING_METRIC_ID}
      summary: Get Monitoring Breakdown Timeseries
      description: >-
        Gets timeseries of breakdown information for a specific dimension and
        metric. Each datapoint in the response represents 5 seconds worth of
        data.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: MONITORING_METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Monitoring Metric
          example: current-concurrent-viewers
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - values:
                      - value: FR
                        metric_value: 0.008195679660675846
                        concurrent_viewers: 2680
                      - value: ES
                        metric_value: 0.010317417106767573
                        concurrent_viewers: 36
                      - value: GB
                        metric_value: 0.008232510579858339
                        concurrent_viewers: 26
                    date: '2023-05-18T19:36:30Z'
                  - values:
                      - value: FR
                        metric_value: 0.00724579660675846
                        concurrent_viewers: 2690
                      - value: ES
                        metric_value: 0.014317417106767573
                        concurrent_viewers: 35
                      - value: GB
                        metric_value: 0.007232510579851874
                        concurrent_viewers: 24
                    date: '2023-05-18T19:36:35Z'
                timeframe:
                  - 1684438590
                  - 1684438600
                total_row_count: 2
  /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries:
    get:
      tags:
        - data/v1 > monitoring > metrics > {MONITORING_METRIC_ID}
      summary: Get Monitoring Timeseries
      description: >-
        Gets Time series information for a specific metric along with the number
        of concurrent viewers.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: MONITORING_METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Monitoring Metric
          example: current-concurrent-viewers
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - concurrent_viewers: 2790
                    date: '2021-01-08T15:31:20Z'
                    value: 2790
                  - concurrent_viewers: 2788
                    date: '2021-01-08T15:31:25Z'
                    value: 2788
                  - concurrent_viewers: 2791
                    date: '2021-01-08T15:31:30Z'
                    value: 2791
                  - concurrent_viewers: 2791
                    date: '2021-01-08T15:31:35Z'
                    value: 2791
                  - concurrent_viewers: 2792
                    date: '2021-01-08T15:31:40Z'
                    value: 2792
                timeframe:
                  - 1610119880
                  - 1610121675
                total_row_count: 1
  /data/v1/monitoring/metrics:
    get:
      tags:
        - data/v1 > monitoring > metrics
      summary: List Monitoring Metrics
      description: Lists available monitoring metrics.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - display_name: Current Average Bitrate
                    name: current-average-bitrate
                  - display_name: Current Concurrent Viewers (CCV)
                    name: current-concurrent-viewers
                  - display_name: Current Rebuffering Percentage
                    name: current-rebuffering-percentage
                  - display_name: Exits Before Video Start
                    name: exits-before-video-start
                  - display_name: Playback Failure Percentage
                    name: playback-failure-percentage
                  - display_name: Video Startup Failure Percentage
                    name: video-startup-failure-percentage
                  - display_name: Video Startup Time
                    name: video-startup-time
                timeframe:
                  - 1610034858
                  - 1610121258
                total_row_count: 1
  /data/v1/monitoring/metrics/{MONITORING_HISTOGRAM_METRIC_ID}/histogram-timeseries:
    get:
      tags:
        - data/v1 > monitoring > metrics
      summary: Get Monitoring Histogram Timeseries
      description: Gets histogram timeseries information for a specific metric.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: MONITORING_HISTOGRAM_METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Monitoring Histogram Metric
          example: video-startup-time
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - average: 5298.1612903225805
                    bucket_values:
                      - count: 3
                        percentage: 0.0967741935483871
                      - count: 0
                        percentage: 0
                      - count: 0
                        percentage: 0
                      - count: 1
                        percentage: 0.03225806451612903
                      - count: 16
                        percentage: 0.5161290322580645
                      - count: 7
                        percentage: 0.22580645161290322
                      - count: 4
                        percentage: 0.12903225806451613
                    max_percentage: 0.5161290322580645
                    median: 4463
                    p95: 14834
                    sum: 31
                    timestamp: '2021-01-08T15:30:00Z'
                  - average: 3828.4146341463415
                    bucket_values:
                      - count: 5
                        percentage: 0.12195121951219512
                      - count: 0
                        percentage: 0
                      - count: 0
                        percentage: 0
                      - count: 4
                        percentage: 0.0975609756097561
                      - count: 18
                        percentage: 0.43902439024390244
                      - count: 12
                        percentage: 0.2926829268292683
                      - count: 2
                        percentage: 0.04878048780487805
                    max_percentage: 0.43902439024390244
                    median: 2625
                    p95: 7378
                    sum: 41
                    timestamp: '2021-01-08T15:31:00Z'
                meta:
                  bucket_unit: milliseconds
                  buckets:
                    - end: 100
                      start: 0
                    - end: 500
                      start: 100
                    - end: 1000
                      start: 500
                    - end: 2000
                      start: 1000
                    - end: 5000
                      start: 2000
                    - end: 10000
                      start: 5000
                    - end: 15000
                      start: 10000
                timeframe:
                  - 1610119800
                  - 1610121540
                total_row_count: 1
  /data/v1/monitoring/dimensions:
    get:
      tags:
        - data/v1 > monitoring
      summary: List Monitoring Dimensions
      description: Lists available monitoring dimensions.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - display_name: ASN
                    name: asn
                  - display_name: CDN
                    name: cdn
                  - display_name: Country
                    name: country
                  - display_name: Operating system
                    name: operating_system
                  - display_name: Player name
                    name: player_name
                  - display_name: Region / State
                    name: region
                  - display_name: Stream type
                    name: stream_type
                  - display_name: Sub property ID
                    name: sub_property_id
                  - display_name: Video series
                    name: video_series
                  - display_name: Video title
                    name: video_title
                  - display_name: View has ad
                    name: view_has_ad
                timeframe:
                  - 1610034823
                  - 1610121223
                total_row_count: 1
  /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown:
    get:
      tags:
        - data/v1 > realtime > metrics > {REALTIME_METRIC_ID}
      summary: Get Real-Time Breakdown
      description: >-
        Gets breakdown information for a specific dimension and metric along
        with the number of concurrent viewers and negative impact score. This
        API is now deprecated, please use the `Get Monitoring Breakdown` API.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: REALTIME_METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Realtime Metric
          example: current-concurrent-viewers
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - concurrent_viewers: 2680
                    metric_value: 0.008195679660675846
                    negative_impact: 1
                    value: FR
                  - concurrent_viewers: 36
                    metric_value: 0.010317417106767573
                    negative_impact: 4
                    value: ES
                  - concurrent_viewers: 30
                    metric_value: 0.06408818534303201
                    negative_impact: 2
                    value: RE
                  - concurrent_viewers: 26
                    metric_value: 0.008232510579858339
                    negative_impact: 7
                    value: GB
                  - concurrent_viewers: 10
                    metric_value: 0
                    negative_impact: 26
                    value: BE
                timeframe:
                  - 1610121421
                  - 1610121421
                total_row_count: 1
  /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries:
    get:
      tags:
        - data/v1 > realtime > metrics > {REALTIME_METRIC_ID}
      summary: Get Real-Time Timeseries
      description: >-
        Gets Time series information for a specific metric along with the number
        of concurrent viewers. This API is now deprecated, please use the `Get
        Monitoring Timeseries` API.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: REALTIME_METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Realtime Metric
          example: current-concurrent-viewers
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - concurrent_viewers: 2790
                    date: '2021-01-08T15:31:20Z'
                    value: 2790
                  - concurrent_viewers: 2788
                    date: '2021-01-08T15:31:25Z'
                    value: 2788
                  - concurrent_viewers: 2791
                    date: '2021-01-08T15:31:30Z'
                    value: 2791
                  - concurrent_viewers: 2791
                    date: '2021-01-08T15:31:35Z'
                    value: 2791
                  - concurrent_viewers: 2792
                    date: '2021-01-08T15:31:40Z'
                    value: 2792
                timeframe:
                  - 1610119880
                  - 1610121675
                total_row_count: 1
  /data/v1/realtime/metrics:
    get:
      tags:
        - data/v1 > realtime > metrics
      summary: List Real-Time Metrics
      description: >-
        Lists available real-time metrics. This API is now deprecated, please
        use the `List Monitoring Metrics` API.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - display_name: Current Average Bitrate
                    name: current-average-bitrate
                  - display_name: Current Concurrent Viewers (CCV)
                    name: current-concurrent-viewers
                  - display_name: Current Rebuffering Percentage
                    name: current-rebuffering-percentage
                  - display_name: Exits Before Video Start
                    name: exits-before-video-start
                  - display_name: Playback Failure Percentage
                    name: playback-failure-percentage
                  - display_name: Video Startup Time
                    name: video-startup-time
                timeframe:
                  - 1610034858
                  - 1610121258
                total_row_count: 1
  /data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries:
    get:
      tags:
        - data/v1 > realtime > metrics
      summary: Get Real-Time Histogram Timeseries
      description: >-
        Gets histogram timeseries information for a specific metric. This API is
        now deprecated, please use the `Get Monitoring Histogram Timeseries`
        API.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: REALTIME_HISTOGRAM_METRIC_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Realtime Histogram Metric
          example: video-startup-time
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - average: 5298.1612903225805
                    bucket_values:
                      - count: 3
                        percentage: 0.0967741935483871
                      - count: 0
                        percentage: 0
                      - count: 0
                        percentage: 0
                      - count: 1
                        percentage: 0.03225806451612903
                      - count: 16
                        percentage: 0.5161290322580645
                      - count: 7
                        percentage: 0.22580645161290322
                      - count: 4
                        percentage: 0.12903225806451613
                    max_percentage: 0.5161290322580645
                    median: 4463
                    p95: 14834
                    sum: 31
                    timestamp: '2021-01-08T15:30:00Z'
                  - average: 3828.4146341463415
                    bucket_values:
                      - count: 5
                        percentage: 0.12195121951219512
                      - count: 0
                        percentage: 0
                      - count: 0
                        percentage: 0
                      - count: 4
                        percentage: 0.0975609756097561
                      - count: 18
                        percentage: 0.43902439024390244
                      - count: 12
                        percentage: 0.2926829268292683
                      - count: 2
                        percentage: 0.04878048780487805
                    max_percentage: 0.43902439024390244
                    median: 2625
                    p95: 7378
                    sum: 41
                    timestamp: '2021-01-08T15:31:00Z'
                meta:
                  bucket_unit: milliseconds
                  buckets:
                    - end: 100
                      start: 0
                    - end: 500
                      start: 100
                    - end: 1000
                      start: 500
                    - end: 2000
                      start: 1000
                    - end: 5000
                      start: 2000
                    - end: 10000
                      start: 5000
                    - end: 15000
                      start: 10000
                timeframe:
                  - 1610119800
                  - 1610121540
                total_row_count: 1
  /data/v1/realtime/dimensions:
    get:
      tags:
        - data/v1 > realtime
      summary: List Real-Time Dimensions
      description: >-
        Lists available real-time dimensions. This API is now deprecated, please
        use the `List Monitoring Dimensions` API.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - display_name: ASN
                    name: asn
                  - display_name: CDN
                    name: cdn
                  - display_name: Country
                    name: country
                  - display_name: Operating system
                    name: operating_system
                  - display_name: Player name
                    name: player_name
                  - display_name: Region / State
                    name: region
                  - display_name: Stream type
                    name: stream_type
                  - display_name: Sub property ID
                    name: sub_property_id
                  - display_name: Video series
                    name: video_series
                  - display_name: Video title
                    name: video_title
                timeframe:
                  - 1610034823
                  - 1610121223
                total_row_count: 1
  /data/v1/incidents/{INCIDENT_ID}:
    get:
      tags:
        - data/v1 > incidents > {INCIDENT_ID}
      summary: Get an Incident
      description: Returns the details of an incident.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: INCIDENT_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Incident
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  affected_views: 2026
                  affected_views_per_hour: 84
                  affected_views_per_hour_on_open: 12857
                  breakdowns:
                    - id: abcdef
                      name: error_type_id
                      value: '499680'
                    - id: abcdef
                      name: video_title
                      value: Cute dogs
                  description: This video is erroring a lot
                  error_description: Error Type ID 499680
                  id: g7q2df
                  impact: '*2026 views* were affected at a rate of *84 per hour*'
                  incident_key: >-
                    045dfcbefdb68c6003aaf3bf5ed217493772519f28f14d129f95eaff159ea6d6b
                  measured_value: 100
                  measured_value_on_close: 8
                  measurement: error_rate
                  notification_rules: []
                  notifications:
                    - attempted_at: '2020-05-14T17:23:08.034662Z'
                      id: 63293
                      queued_at: '2020-05-14T17:23:07.944457Z'
                    - attempted_at: '2020-05-13T17:22:30.444389Z'
                      id: 62212
                      queued_at: '2020-05-13T17:22:30.354828Z'
                  resolved_at: '2020-05-14T17:22:30.000000Z'
                  sample_size: 100
                  sample_size_unit: views
                  severity: alert
                  started_at: '2020-05-13T17:21:54.000000Z'
                  status: closed
                  threshold: 100
                timeframe:
                  - 1610036456
                  - 1610122856
                total_row_count: null
  /data/v1/incidents/{INCIDENT_ID}/related:
    get:
      tags:
        - data/v1 > incidents > {INCIDENT_ID}
      summary: List Related Incidents
      description: Returns all the incidents that seem related to a specific incident.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: INCIDENT_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) ID of the Incident
          example: abcd1234
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - affected_views: 71
                    affected_views_per_hour: 29
                    affected_views_per_hour_on_open: 75
                    breakdowns:
                      - id: abcdef
                        name: error_type_id
                        value: '697070'
                    description: Something is broken
                    error_description: No seriously, something is really really broken :(
                    id: 4u13td
                    impact: '*71 views* were affected at a rate of *29 per hour*'
                    incident_key: >-
                      5312a7c0bbb5d8353bd88602f01fe58eb15e9febac8fd2f0d8ce8f1cb138145c
                    measured_value: 5.9
                    measured_value_on_close: 0.1
                    measurement: error_rate
                    notification_rules: []
                    notifications:
                      - attempted_at: '2021-01-05T09:52:15.119040Z'
                        id: 103014
                        queued_at: '2021-01-05T09:52:14.945157Z'
                      - attempted_at: '2021-01-05T11:31:08.244462Z'
                        id: 102025
                        queued_at: '2021-01-05T11:31:08.061924Z'
                    resolved_at: '2021-01-05T11:31:04.000000Z'
                    sample_size: 1000
                    sample_size_unit: views
                    severity: alert
                    started_at: '2021-01-05T09:04:46.000000Z'
                    status: closed
                    threshold: 5
                  - affected_views: 132
                    affected_views_per_hour: 11
                    affected_views_per_hour_on_open: 65
                    breakdowns:
                      - id: abcdef
                        name: video_title
                        value: Layla the dog video 1337
                      - id: abcdef
                        name: error_type_id
                        value: '697065'
                    description: Something else is broken
                    error_description: 'Detailed error: On no!'
                    id: rd9579
                    impact: '*132 views* were affected at a rate of *11 per hour*'
                    incident_key: >-
                      fd9add7a85a013d768f4039f9e726133eddb476c2f16b22ebfe56f18f7c03b27
                    measured_value: 97
                    measured_value_on_close: 1
                    measurement: error_rate
                    notification_rules: []
                    notifications:
                      - attempted_at: '2020-12-31T09:26:19.416919Z'
                        id: 102198
                        queued_at: '2020-12-31T09:26:18.987717Z'
                      - attempted_at: '2020-12-31T20:23:57.279325Z'
                        id: 101269
                        queued_at: '2020-12-31T20:23:56.997068Z'
                    resolved_at: '2020-12-31T20:22:54.000000Z'
                    sample_size: 100
                    sample_size_unit: views
                    severity: alert
                    started_at: '2020-12-31T07:56:22.000000Z'
                    status: closed
                    threshold: 96
                timeframe:
                  - 1610035979
                  - 1610122379
                total_row_count: 2
  /data/v1/incidents:
    get:
      tags:
        - data/v1 > incidents
      summary: List Incidents
      description: Returns a list of incidents.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - affected_views: 71
                    affected_views_per_hour: 29
                    affected_views_per_hour_on_open: 75
                    breakdowns:
                      - id: abcdef
                        name: error_type_id
                        value: '697070'
                    description: Something is broken
                    error_description: No seriously, something is really really broken :(
                    id: 4u13td
                    impact: '*71 views* were affected at a rate of *29 per hour*'
                    incident_key: >-
                      5312a7c0bbb5d8353bd88602f01fe58eb15e9febac8fd2f0d8ce8f1cb138145c
                    measured_value: 5.9
                    measured_value_on_close: 0.1
                    measurement: error_rate
                    notification_rules: []
                    notifications:
                      - attempted_at: '2021-01-05T09:52:15.119040Z'
                        id: 103014
                        queued_at: '2021-01-05T09:52:14.945157Z'
                      - attempted_at: '2021-01-05T11:31:08.244462Z'
                        id: 102025
                        queued_at: '2021-01-05T11:31:08.061924Z'
                    resolved_at: '2021-01-05T11:31:04.000000Z'
                    sample_size: 1000
                    sample_size_unit: views
                    severity: alert
                    started_at: '2021-01-05T09:04:46.000000Z'
                    status: closed
                    threshold: 5
                  - affected_views: 132
                    affected_views_per_hour: 11
                    affected_views_per_hour_on_open: 65
                    breakdowns:
                      - id: abcdef
                        name: video_title
                        value: Layla the dog video 1337
                      - id: abcdef
                        name: error_type_id
                        value: '697065'
                    description: Something else is broken
                    error_description: 'Detailed error: On no!'
                    id: rd9579
                    impact: '*132 views* were affected at a rate of *11 per hour*'
                    incident_key: >-
                      fd9add7a85a013d768f4039f9e726133eddb476c2f16b22ebfe56f18f7c03b27
                    measured_value: 97
                    measured_value_on_close: 1
                    measurement: error_rate
                    notification_rules: []
                    notifications:
                      - attempted_at: '2020-12-31T09:26:19.416919Z'
                        id: 102198
                        queued_at: '2020-12-31T09:26:18.987717Z'
                      - attempted_at: '2020-12-31T20:23:57.279325Z'
                        id: 101269
                        queued_at: '2020-12-31T20:23:56.997068Z'
                    resolved_at: '2020-12-31T20:22:54.000000Z'
                    sample_size: 100
                    sample_size_unit: views
                    severity: alert
                    started_at: '2020-12-31T07:56:22.000000Z'
                    status: closed
                    threshold: 96
                timeframe:
                  - 1610035979
                  - 1610122379
                total_row_count: 2
  /data/v1/errors:
    get:
      tags:
        - data/v1
      summary: List Errors
      description: Returns a list of errors.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                total_row_count: 1
                timeframe:
                  - 1610027061
                  - 1610113461
                data:
                  - percentage: 30
                    notes: a helpful note
                    message: an error message
                    last_seen: '2021-01-08T13:42:39Z'
                    id: 1
                    description: a description for this error
                    count: 1
                    code: 100
  /system/v1/signing-keys/{SIGNING_KEY_ID}:
    get:
      tags:
        - system/v1/signing-keys > {SIGNING_KEY_ID}
      summary: Retrieve a signing key
      description: >
        Retrieves the details of a signing key that has previously

        been created. Supply the unique signing key ID that was returned from
        your

        previous request, and Mux will return the corresponding signing key
        information.

        **The private key is not returned in this response.**
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: SIGNING_KEY_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the signing key.
          example: do ea cupidatat cillum ipsum
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  id: jc6lJiCLMjyC202EXtRQ644sShzDv6x5tWJrbvUFpvmo
                  created_at: '1608632647'
    delete:
      tags:
        - system/v1/signing-keys > {SIGNING_KEY_ID}
      summary: Delete a signing key
      description: >-
        Deletes an existing signing key. Use with caution, as this will
        invalidate any existing signatures and no JWTs can be signed using the
        key again.
      parameters:
        - name: SIGNING_KEY_ID
          in: path
          schema:
            type: string
          required: true
          description: (Required) The ID of the signing key.
          example: do ea cupidatat cillum ipsum
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /system/v1/signing-keys:
    post:
      tags:
        - system/v1/signing-keys
      summary: Create a signing key
      description: >-
        Creates a new signing key pair. When creating a new signing key, the API
        will generate a 2048-bit RSA key-pair and return the private key and a
        generated key-id; the public key will be stored at Mux to validate
        signed tokens.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  private_key: abcd123=
                  id: vI5KTQ78ohYriuvWKHY6COtZWXexHGLllxksOdZuya8
                  created_at: '1610108345'
    get:
      tags:
        - system/v1/signing-keys
      summary: List signing keys
      description: Returns a list of signing keys.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                  - id: vI5KTQ78ohYriuvWKHY6COtZWXexHGLllxksOdZuya8
                    created_at: '1610108345'
                  - id: jc6lJiCLMjyC202EXtRQ644sShzDv6x5tWJrbvUFpvmo
                    created_at: '1608632647'
