openapi: 3.0.2
info:
  version: BETA
  title: Wowza Video REST API Reference Documentation
  license:
    name: Terms of Use
    url: https://www.wowza.com/legal/terms-of-use
  description: >
    API lifecycle phase:
    [Beta](https://www.wowza.com/docs/wowza-video-rest-api-lifecycle-management#api-lifecycle0)



    <table>

    <tr style="background-color:lightgrey;"><td>

    <strong>Want to take the API for a test run?</strong>


    All you'll need is a [Wowza Video
    subscription](https://www.wowza.com/pricing), or [free
    trial](https://www.wowza.com/free-trial), for the API access token. Then,
    fork [our collection in
    Postman](https://www.postman.com/wowzavideo/workspace/wowza-video-rest-api)
    and you'll be

    making calls to our REST API in minutes!


    See [Trial the Wowza Video REST API using
    Postman](https://www.wowza.com/docs/trial-the-wowza-video-rest-api-using-postman)
    for more information.

    </td>

    </tr>

    </table>



    This reference documentation provides details about the operations,
    parameters, and request and response schemas for every resource and endpoint
    in the Wowza Video REST API.

    Samples appear in the right column. Sample requests are presented in cURL
    (Shell) and JavaScript; some samples also include just the JSON object.
    Response samples are all JSON. 

    Examples in cURL use environment variables so you can easily copy and paste
    them. To learn more, see [Using
    cURL](https://wowza.com/docs/how-to-use-the-wowza-video-rest-api#curl).



    Reference documentation is available for every version of the API. Use the
    **Version** menu at the top of the page to access the reference doc for a
    different version of the API.
tags:
  - name: live_streams
    description: >-
      Operations related to live streams. A live stream is a single, linear
      video broadcast. You broadcast a live stream by receiving encoded source
      video into the Wowza Video service and letting Wowza Video transcode the
      stream and deliver it to viewers. A live stream is essentially a one-stop
      method for creating a transcoder, output renditions, stream targets, and
      associated players. 
    x-displayName: Live Streams
  - name: schedules
    description: >-
      Operations related to schedules. Schedules allow you to automatically
      start or stop a live stream or transcoder at a predetermined date and
      time. You can configure a schedule to start and/or stop a live stream or
      transcoder just once, or you can configure it to repeat the behavior on a
      regular basis. See [About
      schedules](https://www.wowza.com/docs/schedule-live-streams-and-transcoders#aboutSCH)
      to learn more.
    x-displayName: Schedules
  - name: stream_sources
    description: >-
      Operations related to stream sources. You can create a Wowza stream source
      and associate it to a live stream or transcoder.
       ### Wowza Stream Sources
       When you set up a Wowza stream source with a live stream or transcoder, Wowza Video can automatically detect broadcast location, automatically start a stream when the video source starts, and automatically stop a stream after the video source disconnects.
    x-displayName: Stream Sources
  - name: stream_targets
    description: >-
      Operations related to stream targets. A stream target is a destination for
      a stream. Stream targets can be Wowza Video edge resources; custom,
      external destinations, target destinations.
       ### Wowza CDN Stream Targets
       Wowza CDN stream targets distribute streams to players. When you create a live stream in the API, a Wowza CDN stream target is created automatically. 
       

       In contrast, you can use ``/stream_targets/wowza_cdn`` endpoints to manually create Wowza CDN stream targets and associate them with transcoders.
       
       
       With Wowza CDN stream targets, you can use geo-blocking to control locations where your stream can be viewed, and you can use token authentication to restrict access to streams. Advanced configuration properties are available for Wowza CDN stream targets.
       
       ### Custom Stream Targets
       Custom stream targets connect to external CDNs to deliver streams to viewers. You manually create custom stream targets and associate them to a transcoder.
    x-displayName: Stream Targets
  - name: transcoders
    description: >-
      Operations related to transcoders, output renditions, and output stream
      targets.
       ### Transcoders
       Wowza Video transcoders allow you to customize transcoding processes by creating transcoders that are optimized for various network or streaming conditions. When you create a transcoder through the ``/transcoders`` endpoint, you must manually configure output renditions and associated output stream targets.

       Transcoders, like live streams, can be adaptive bitrate or passthrough. An adaptive bitrate transcoder generates multiple output renditions of your live stream, at different bitrates. A passthrough transcoder, in contrast, sends the source video to a stream target without performing transcoding. Passthrough transcoders, which can only be created if you have a subscription plan that supports them, accrue processing time, bandwidth, and egress usage, but much less than their adaptive bitrate counterparts.
       ### Output Renditions
       Before you can start an adaptive bitrate transcoder, you must use the ``/transcoders/{transcoder_id}/outputs`` operations to define the adaptive bitrate output renditions that you want the transcoder to create. Passthrough transcoders require only one output rendition because they send source video to a stream target without transcoding.
       ### Output Stream Targets
       Transcoders require output stream targets before you can start them. Although you create and configure stream targets using the different ``/stream_targets`` operations, you must associate a stream target to a transcoder's output rendition using the /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets operations. For an adaptive bitrate transcoder with multiple output renditions defined, you must create output stream targets to associate a stream target to each output rendition. For a passthrough transcoder, you only need one output stream target.
    x-displayName: Transcoders
  - name: real_time
    description: >-
      Operations related to Real-Time Streaming at Scale. If your audience is
      fewer than 300 viewers or you want to deliver a stream in near real time
      alongside other delivery protocols, <a
      href="https://www.wowza.com/docs/deliver-webrtc-streams-to-viewers-using-the-wowza-video-rest-api">use
      our WebRTC solution</a>.


      <blockquote>To enable and purchase capacity for Real-Time Streaming at
      Scale for your account and access the <tt>/real_time</tt> operations,
      contact 720.279.8163 or <a
      href="https://www.wowza.com/professional-services#get-a-quote">schedule a
      call</a>.</blockquote>
    x-displayName: Real-Time Streams
  - name: usage
    description: >-
      Operations related to stream target analytics, including CDN usage and
      viewer data.
    x-displayName: Stream Targets
  - name: usage_transcoders
    description: Operations related to transcoder analytics.
    x-displayName: Transcoders
  - name: usage_live_streams
    description: Operations related to livestream analytics.
    x-displayName: Livestreams
  - name: usage_real_time_streams
    description: Operations related to real-time streams analytics.
    x-displayName: Real Time Streams
  - name: usage_account
    description: Operations related to stream analytics for an account.
    x-displayName: Account
  - name: analytics_viewers
    description: Operations related to viewer analytics.
    x-displayName: Viewers
  - name: analytics_ingest
    description: Operations related to ingest analytics for a live stream.
    x-displayName: Ingest
  - name: analytics_engagement
    description: Operations related to engagement analytics for a VOD stream.
    x-displayName: Engagement
  - name: analytics_popularity
    description: Operations related to popularity analytics.
    x-displayName: Popularity
  - name: quality_of_experience
    description: Operations related to quality of experience metrics.
    x-displayName: Quality of Experience
  - name: videos
    description: Operations related to uploading and categorizing videos.
    x-displayName: Videos
  - name: categories
    description: Operations related to categorizing videos.
    x-displayName: Categories
  - name: advanced_token_authentication
    description: >-
      Operations related to using advanced token authentication, known in Wowza
      Video as a default playback token behavior option, with videos. 


      Use token authentication when distributing valuable or sensitive video
      content to audiences to ensure that only authorized users can access the
      content within the intended application. This allows for protection of
      intellectual property, compliance with regulations, and the ability to
      maintain control over content distribution. 


      Through the <a
      href="https://www.wowza.com/docs/video-details-page-in-wowza-video"
      target="_blank">UI</a> or <a
      href="https://developer.wowza.com/docs/wowza-video/api/video/current/tag/videos/#tag/videos/operation/patchVideo"
      target="_blank">Wowza Video API</a>, you can choose one of the following
      options for token authentication of a video:
       
       - **NO_TOKEN** - Video files are accessible and can be downloaded and played by anyone at any time. This is the default.  
       - **BASIC_TOKEN** - The platform automatically creates tokenized video URLs. This setting makes it hard for a viewer to extract the video URL and store it for usage in unintended applications over time since the embed URL, which has the token as part of the URL, will only be playable for 48 hours. The token auto renews after 48 hours when used in the intended application. 
       - **ADVANCED_TOKEN** - You add the stream's JS embed code (Share Stream) and a token to your site to provide tokenization.  The protections are similar to those for the Basic Token option except you customize the time limit, geographical limits, etc. during token creation. 
       - **FOLLOW_DEFAULT:** - The token behavior is based on the **Default Playback Token Behavior** setting you selected for your Wowza account. See the <a href="https://www.wowza.com/docs/org-setting-page-in-wowza-video" target="_blank">Org Settings page in Wowza Video</a> article for where to set this configuration. 

          **Note:** You'll use the <a href="https://developer.wowza.com/docs/wowza-video/api/video/current/tag/videos/#tag/videos/operation/patchVideo" target="_blank">/videos endpoints</a> to update and review the token authentication enums bulleted above.

      Before selecting to use the **ADVANCED_TOKEN**, you must, first, either: 

       - Generate a key id via the Wowza Video API, then customize and generate a token via the Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token.  
       - Generate a key id and key via the Wowza Video 2.0 API, then customize and generate a standard common access token (CAT) through the means you usually use to create tokens to add to your site. You'll need the key id and key to create and sign the token.  


       After you have your playback token, you add the video JS-embed and the playback token to your site if you're going to use the **ADVANCED_TOKEN** option. The JS-embed code automatically adds the player and related video to your site. See the section on <a href="<a href="https://developer.wowza.com/docs/wowza-video/api/video/current/tag/videos/#tag/videos/operation/patchVideo" target="_blank">how to embed the player and video</a>". 
    x-displayName: Advanced Token Authentication
  - name: clipping
    description: Operations related to clipping and stitching videos and live streams.
    x-displayName: Clipping
paths:
  /live_streams:
    post:
      summary: Create a live stream
      description: This operation creates a live stream.
      operationId: createLiveStream
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/live_streams" \
              -d $'{
              "live_stream": {
                "name": "My New Live Stream",
                "transcoder_type": "transcoded",
                "billing_mode": "pay_as_you_go",
                "broadcast_location": "us_west_california",
                "encoder": "other_rtmp",
                "delivery_method": "push",
                "aspect_ratio_width": 1920,
                "aspect_ratio_height": 1080
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/live_streams';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "live_stream": {
                "name": "My New Live Stream",
                "transcoder_type": "transcoded",
                "billing_mode": "pay_as_you_go",
                "broadcast_location": "us_west_california",
                "encoder": "other_rtmp",
                "delivery_method": "push",
                "aspect_ratio_width": 1920,
                "aspect_ratio_height": 1080
              }
            }));
            req.end();
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/live_stream_create_input'
        description: >-
          Provide the details of the live stream to create in the body of the
          request.
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - live_stream
                properties:
                  live_stream:
                    $ref: '#/components/schemas/live_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch all live streams
      description: >-
        This operation shows limited details for all of your live streams. For
        detailed information, fetch a single live stream.
      operationId: listLiveStreams
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/live_streams"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/live_streams';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/live_streams'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
  /live_streams/{id}:
    get:
      summary: Fetch a live stream
      description: This operation shows the details of a specific live stream.
      operationId: showLiveStream
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/live_streams/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/live_streams/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - live_stream
                properties:
                  live_stream:
                    $ref: '#/components/schemas/live_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    patch:
      summary: Update a live stream
      description: This operation updates a live stream.
      operationId: updateLiveStream
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/live_streams/2adffc17" \
              -d $'{
              "live_stream": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/live_streams/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname',
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "live_stream": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/live_stream_update_input'
        description: >-
          Provide the details of the live stream to update in the body of the
          request.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - live_stream
                properties:
                  live_stream:
                    $ref: '#/components/schemas/live_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      summary: Delete a live stream
      description: >-
        This operation deletes a live stream, including all assigned outputs and
        targets. <br><br><b>Note</b>: You can't remove live streams that have an
        asset_id. Assets must be removed by sending a DEL request to the /assets
        endpoint. 
      operationId: deleteLiveStream
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/live_streams/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/live_streams/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /live_streams/{id}/start:
    put:
      summary: Start a live stream
      description: This operation starts a live stream.
      operationId: startLiveStream
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/live_streams/2adffc17/start"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/live_streams/2adffc17/start';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - live_stream
                properties:
                  live_stream:
                    type: object
                    title: live_stream
                    properties:
                      state:
                        type: string
                        description: The state of the live stream.
                        example: starting
                        enum:
                          - started
                          - stopped
                          - starting
                          - stopping
                          - resetting
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /live_streams/{id}/stop:
    put:
      summary: Stop a live stream
      description: This operation stops a live stream.
      operationId: stopLiveStream
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/live_streams/2adffc17/stop"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/live_streams/2adffc17/stop';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - live_stream
                properties:
                  live_stream:
                    type: object
                    title: live_stream
                    properties:
                      state:
                        type: string
                        description: The state of the live stream.
                        example: stopped
                        enum:
                          - started
                          - stopped
                          - starting
                          - stopping
                          - resetting
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /live_streams/{id}/reset:
    put:
      summary: Reset a live stream
      description: This operation resets a live stream.
      operationId: resetLiveStream
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/live_streams/2adffc17/reset"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/live_streams/2adffc17/reset';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - live_stream
                properties:
                  live_stream:
                    type: object
                    title: live_stream
                    properties:
                      state:
                        type: string
                        description: The state of the live stream.
                        example: resetting
                        enum:
                          - started
                          - stopped
                          - starting
                          - stopping
                          - resetting
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /live_streams/{id}/regenerate_connection_code:
    put:
      summary: Regenerate the connection code for a live stream
      description: This operation regenerates the connection code of a live stream.
      operationId: regenerateConnectionCodeLiveStream
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/live_streams/2adffc17/regenerate_connection_code"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/live_streams/2adffc17/regenerate_connection_code';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });

            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - live_stream
                properties:
                  live_stream:
                    type: object
                    title: live_stream
                    properties:
                      connection_code:
                        type: string
                        description: >-
                          A six-character, alphanumeric string that allows
                          certain encoders, including Wowza Streaming Engine and
                          the Wowza GoCoder app, to connect with Wowza Video.
                          The code can be used once and expires 24 hours after
                          it's created.
                        example: 0cd2e8
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /live_streams/{id}/thumbnail_url:
    get:
      summary: Fetch the thumbnail URL of a live stream
      description: This operation shows the thumbnail URL of a started live stream.
      operationId: showLiveStreamThumbnailUrl
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/live_streams/2adffc17/thumbnail_url"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/live_streams/2adffc17/thumbnail_url';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - live_stream
                properties:
                  live_stream:
                    type: object
                    title: live_stream
                    properties:
                      thumbnail_url:
                        type: string
                        description: The URL to receive the preview thumbnail.
                        example: >-
                          https://cloud.wowza.com/proxy/stats/?target=10.11.12.13&app=app-B8P6K226&stream=99b62146@130135.stream&media=json
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /live_streams/{id}/state:
    get:
      summary: Fetch the state of a live stream
      description: This operation shows the current state of a live stream.
      operationId: showLiveStreamState
      tags:
        - live_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/live_streams/2adffc17/state"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/live_streams/2adffc17/state';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - live_stream
                properties:
                  live_stream:
                    type: object
                    title: live_stream
                    properties:
                      ip_address:
                        type: string
                        description: >-
                          The IP address of the live stream instance. If the
                          live stream *state* is anything other than
                          **started**, the *ip_address* is **0.0.0.0**.
                        example: 0.0.0.0
                      state:
                        type: string
                        description: The state of the live stream.
                        example: stopped
                        enum:
                          - started
                          - stopped
                          - starting
                          - stopping
                          - resetting
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /schedules:
    post:
      summary: Create a schedule
      description: This operation creates a schedule.
      operationId: createSchedule
      tags:
        - schedules
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/schedules" \
              -d $'{
              "schedule": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/schedules';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "schedule": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schedule_create_input'
        description: >-
          Provide the details of the schedule to create in the body of the
          request.
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - schedule
                properties:
                  schedule:
                    $ref: '#/components/schemas/schedule'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch all schedules
      description: This operation shows the details of all of your schedules.
      operationId: listSchedules
      tags:
        - schedules
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/schedules"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/schedules';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schedules'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
  /schedules/{id}:
    get:
      summary: Fetch a schedule
      description: This operation shows the details of a specific schedule.
      operationId: showSchedule
      tags:
        - schedules
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/schedules/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/schedules/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the schedule.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - schedule
                properties:
                  schedule:
                    $ref: '#/components/schemas/schedule'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    patch:
      summary: Update a schedule
      description: This operation updates a schedule.
      operationId: updateSchedule
      tags:
        - schedules
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/schedules/2adffc17" \
              -d $'{
              "schedule": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/schedules/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname',
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "schedule": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the schedule.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schedule_update_input'
        description: >-
          Provide the details of the schedule to update in the body of the
          request.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - schedule
                properties:
                  schedule:
                    $ref: '#/components/schemas/schedule'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      summary: Delete a schedule
      description: This operation deletes a schedule.
      operationId: deleteSchedule
      tags:
        - schedules
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/schedules/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/schedules/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the schedule.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /schedules/{id}/enable:
    put:
      summary: Enable a schedule
      description: This operation enables a schedule.
      operationId: enableSchedule
      tags:
        - schedules
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/schedules/2adffc17/enable"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/schedules/2adffc17/enable';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the schedule.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - schedule
                properties:
                  schedule:
                    type: object
                    title: schedule
                    properties:
                      state:
                        type: string
                        description: >-
                          A schedule must be **enabled** to run. Specify
                          **enabled** to run the schedule or **disabled** to
                          turn off the schedule so that it doesn't run.
                        example: enabled
                        enum:
                          - enabled
                          - disabled
                          - expired
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /schedules/{id}/disable:
    put:
      summary: Disable a schedule
      description: This operation disables a schedule.
      operationId: disableSchedule
      tags:
        - schedules
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/schedules/2adffc17/disable"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/schedules/2adffc17/disable';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the schedule.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - schedule
                properties:
                  schedule:
                    type: object
                    title: schedule
                    properties:
                      state:
                        type: string
                        description: >-
                          A schedule must be **enabled** to run. Specify
                          **enabled** to run the schedule or **disabled** to
                          turn off the schedule so that it doesn't run.
                        example: disabled
                        enum:
                          - enabled
                          - disabled
                          - expired
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /schedules/{id}/state:
    get:
      summary: Fetch the state of a schedule
      description: This operation shows the current state of a schedule.
      operationId: showScheduleState
      tags:
        - schedules
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/schedules/2adffc17/state"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/schedules/2adffc17/state';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the schedule.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - schedule
                properties:
                  schedule:
                    type: object
                    title: schedule
                    properties:
                      state:
                        type: string
                        description: >-
                          A schedule must be **enabled** to run. Specify
                          **enabled** to run the schedule or **disabled** to
                          turn off the schedule so that it doesn't run.
                        example: enabled
                        enum:
                          - enabled
                          - disabled
                          - expired
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /stream_sources:
    get:
      summary: Fetch all stream sources
      description: >-
        This operation shows limited details for all of your stream sources. For
        detailed information, fetch a single stream source of the appropriate
        type.
      operationId: listStreamSources
      tags:
        - stream_sources
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/stream_sources"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_sources';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_sources'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
  /stream_sources/wowza:
    post:
      summary: Create a Wowza stream source
      description: >-
        (Available from version 1.4) This operation creates a Wowza stream
        source.  A Wowza stream source enables automatic transcoder start, stop,
        and broadcast location detection.
      operationId: createWowzaStreamSource
      tags:
        - stream_sources
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/stream_sources/wowza" \
              -d $'{
              "stream_source_wowza": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_sources/wowza';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "stream_source_wowza": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/wowza_stream_source_create_input'
        description: >-
          Provide the details of the stream source to add in the body of the
          request.
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - stream_source_wowza
                properties:
                  stream_source_wowza:
                    $ref: '#/components/schemas/stream_source_wowza_create'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /stream_sources/wowza/{id}:
    get:
      summary: Fetch a Wowza stream source
      description: >-
        (Available from version 1.4) This operation shows details of a specific
        Wowza stream source. A Wowza stream source enables automatic transcoder
        start, stop, and broadcast location detection.
      operationId: showWowzaStreamSource
      tags:
        - stream_sources
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/stream_sources/wowza/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_sources/wowza/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the Wowza stream
            source.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - stream_source_wowza
                properties:
                  stream_source_wowza:
                    $ref: '#/components/schemas/stream_source_wowza'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    patch:
      summary: Update a Wowza stream source
      description: >-
        (Available from version 1.4) This operation updates a Wowza stream
        source. A Wowza stream source enables automatic transcoder start, stop,
        and broadcast location detection. 
      operationId: updateWowzaStreamSource
      tags:
        - stream_sources
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/stream_sources/wowza/2adffc17" \
              -d $'{
              "stream_source_wowza": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_sources/wowza/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname',
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "stream_source_wowza": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the Wowza stream
            source.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/wowza_stream_source_update_input'
        description: >-
          Provide the details of the stream source to update in the body of the
          request.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - stream_source_wowza
                properties:
                  stream_source_wowza:
                    $ref: '#/components/schemas/wowza_stream_source_patch_response'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      summary: Delete a Wowza stream source
      description: >-
        (Available from version 1.4) This operation deletes a Wowza stream
        source.
      operationId: deleteWowzaStreamSource
      tags:
        - stream_sources
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/stream_sources/wowza/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_sources/wowza/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the Wowza stream
            source.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /stream_targets:
    get:
      summary: Fetch all stream targets
      description: >-
        This operation lists limited details for custom stream targets and Wowza
        CDN stream targets. For detailed information, fetch a single stream
        target of a specific type.
      operationId: listStreamTargets
      tags:
        - stream_targets
      parameters:
        - $ref: '#/components/parameters/assignable_stream_target'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/stream_targets"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_targets'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
  /stream_targets/{id}:
    get:
      summary: Fetch a stream target
      description: >-
        This operation shows the details of a specific stream target whether it
        be a Wowza CDN, custom, Facebook Live, or LinkedIn live stream target.
      operationId: listStreamTarget
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/stream_targets/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  stream_target_custom:
                    $ref: '#/components/schemas/stream_target_custom'
                  stream_target_wowza_cdn:
                    $ref: '#/components/schemas/stream_target_fastly'
                  stream_target_facebook:
                    $ref: '#/components/schemas/stream_target_facebook'
                  stream_target_linkedin:
                    $ref: '#/components/schemas/stream_target_linkedin'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /stream_targets/custom:
    post:
      summary: Create a custom stream target
      description: >-
        This operation creates a custom stream target for an external,
        third-party destination.
      operationId: createCustomStreamTarget
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/stream_targets/custom" \
              -d $'{
              "stream_target_custom": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/custom';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "stream_target_custom": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_stream_target_create_input'
        description: >-
          Provide the details of the custom stream target to create in the body
          of the request.
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  stream_target_custom:
                    $ref: '#/components/schemas/stream_target_custom'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch all custom stream targets
      description: >-
        This operation lists limited details for all of your custom stream
        targets. For detailed information, fetch a single custom stream target.
      operationId: listCustomStreamTargets
      tags:
        - stream_targets
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/stream_targets/custom"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/custom';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_targets_custom'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
  /stream_targets/custom/{id}:
    get:
      summary: Fetch a custom stream target
      description: This operation shows the details of a specific custom stream target.
      operationId: showCustomStreamTarget
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/stream_targets/custom/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/custom/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the custom stream
            target.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  stream_target_custom:
                    $ref: '#/components/schemas/stream_target_custom'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    patch:
      summary: Update a custom stream target
      description: This operation updates a custom stream target.
      operationId: updateCustomStreamTarget
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/stream_targets/custom/2adffc17" \
              -d $'{
              "stream_target_custom": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/custom/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname',
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "stream_target_custom": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the custom stream
            target.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_stream_target_update_input'
        description: >-
          Provide the details of the custom stream target to update in the body
          of the request.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  stream_target_custom:
                    $ref: '#/components/schemas/custom_stream_target_patch_response'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      summary: Delete a custom stream target
      description: >-
        This operation deletes a custom stream target. <br><br><b>Note</b>: You
        can't remove stream targets that have an asset_id. Assets must be
        removed by sending a DEL request to the /assets endpoint. 
      operationId: deleteCustomStreamTarget
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/stream_targets/custom/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/custom/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the custom stream
            target.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /stream_targets/wowza_cdn:
    post:
      summary: Create a Wowza CDN stream target
      description: >-
        (Available from version 1.4) This operation creates a Wowza CDN stream
        target to deliver your stream using the Wowza CDN.
      operationId: createFastlyStreamTarget
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/stream_targets/wowza_cdn" \
              -d $'{
              "stream_target_wowza_cdn": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/wowza_cdn';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "stream_target_wowza_cdn": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/fastly_stream_target_create_input'
        description: >-
          Provide the details of the Wowza CDN stream target to create in the
          body of the request.
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - stream_target_wowza_cdn
                properties:
                  stream_target_wowza_cdn:
                    $ref: '#/components/schemas/stream_target_fastly'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch all Wowza CDN stream targets
      description: >-
        (Available from version 1.4) This operation lists limited details for
        all of your Wowza CDN stream targets. For detailed information, fetch a
        single target.
      operationId: listFastlyStreamTargets
      tags:
        - stream_targets
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/stream_targets/wowza_cdn"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/wowza_cdn';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_targets_fastly'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
  /stream_targets/wowza_cdn/{id}:
    get:
      summary: Fetch a Wowza CDN stream target
      description: >-
        (Available from version 1.4) This operation shows the details of a
        specific Wowza CDN stream target.
      operationId: showFastlyStreamTarget
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/stream_targets/wowza_cdn/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/wowza_cdn/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - stream_target_wowza_cdn
                properties:
                  stream_target_wowza_cdn:
                    $ref: '#/components/schemas/stream_target_fastly'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    patch:
      summary: Update a Wowza CDN stream target
      description: >-
        (Available from version 1.4) This operation updates a Wowza CDN stream
        target.
      operationId: updateFastlyStreamTarget
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/stream_targets/wowza_cdn/2adffc17" \
              -d $'{
              "stream_target_wowza_cdn": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/wowza_cdn/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname',
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "stream_target_wowza_cdn": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/fastly_stream_target_update_input'
        description: >-
          Provide the details of the Wowza CDN stream target to update in the
          body of the request.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - stream_target_wowza_cdn
                properties:
                  stream_target_wowza_cdn:
                    $ref: '#/components/schemas/fastly_stream_target_patch_response'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      summary: Delete a Wowza CDN stream target
      description: >-
        (Available from version 1.4) This operation deletes a Wowza CDN stream
        target.  <br><br><b>Note</b>: You can't remove stream targets that have
        an asset_id. Assets must be removed by sending a DEL request to the
        /assets endpoint. 
      operationId: deleteFastlyStreamTarget
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/stream_targets/wowza_cdn/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/wowza_cdn/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /stream_targets/{id}/regenerate_connection_code:
    put:
      summary: Regenerate the connection code for any stream target
      description: >-
        This operation regenerates the connection code of any kind of stream
        target.
      operationId: regenerateConnectionCodeStreamTarget
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/stream_targets/2adffc17/regenerate_connection_code"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/stream_targets/2adffc17/regenerate_connection_code';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });

            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - stream_target
                properties:
                  stream_target:
                    type: object
                    title: stream_target
                    properties:
                      connection_code:
                        type: string
                        description: >-
                          A six-character, alphanumeric string that allows
                          select encoders, such as Wowza Streaming Engine or the
                          Wowza GoCoder app, to send an encoded stream to a
                          stream target in Wowza Video. The code can be used
                          once and expires 24 hours after it's created.
                        example: 0cd2e8
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /stream_targets/{stream_target_id}/properties:
    post:
      summary: Configure a property for a stream target
      description: >-
        This operation configures a property for a stream target. The properties
        available will depend on the *provider* you are using and are noted in
        the key descriptions below. For example, if you are using the provider
        **Wowza CDN on Fastly**, look for that in the descriptions.


        For a comprehensive resource describing the use of advanced properties,
        see [Set advanced properties with the Wowza Video REST
        API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api).
      operationId: createStreamTargetProperty
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/stream_targets/2adffc17/properties" \
              -d $'{
              "property": {
                "key": "chunkSize",
                "section": "hls",
                "value": 6
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/2adffc17/properties';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "property": {
                "key": "chunkSize",
                "section": "hls",
                "value": 6
              }
            }));
            req.end();
      parameters:
        - name: stream_target_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/stream_target_property_create_input'
                - $ref: '#/components/schemas/stream_target_properties_create_input'
        description: >-
          Provide the details of the property or properties to configure in the
          body of the request. You must include either *property* or
          *properties* in the request as the root object.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: >-
                      #/components/schemas/stream_target_property_create_input_repsonse
                  - $ref: >-
                      #/components/schemas/stream_target_properties_create_input_response
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch all properties of a stream target
      description: >-
        This operation shows the details of all of the properties assigned to a
        specific stream target. The properties returned will depend on the
        *provider* you are using and are noted in the key descriptions below.


          For a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video
          REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api).
      operationId: listStreamTargetProperties
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/stream_targets/2adffc17/properties"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/stream_targets/2adffc17/properties';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: stream_target_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stream_target_properties'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /stream_targets/{stream_target_id}/properties/{id}:
    get:
      summary: Fetch a property of a stream target
      description: >-
        This operation shows the details of a specific property assigned to a
        specific stream target. The properties returned will depend on the
        *provider* you are using and are noted in the key descriptions below. 


          For a comprehensive resource describing the use of advanced properties, see [Set advanced properties with the Wowza Video
          REST API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api).
      operationId: showStreamTargetProperty
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/stream_targets/2adffc17/properties/hls-chunkSize"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/stream_targets/2adffc17/properties/hls-chunkSize';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: stream_target_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: >-
            The unique string that identifies the stream target property. The
            string contains the *section* and the *key*, connected by a dash.
            For example, **hls-chunkSize**.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/stream_target_property_create_input_repsonse
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    delete:
      summary: Delete a stream target property
      description: This operation removes a property from a stream target.
      operationId: deleteStreamTargetProperty
      tags:
        - stream_targets
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/stream_targets/2adffc17/properties/hls-chunkSize"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/stream_targets/2adffc17/properties/hls-chunkSize';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: stream_target_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: >-
            The unique string that identifies the stream target property. The
            string contains the *section* and the *key*, connected by a dash.
            For example, **hls-chunkSize**.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders:
    post:
      summary: Create a transcoder
      description: This operation creates a transcoder.
      operationId: createTranscoder
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/transcoders" \
              -d $'{
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transcoder_create_input'
        description: >-
          Provide the details of the transcoder to create in the body of the
          request.
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    $ref: '#/components/schemas/transcoder'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch all transcoders
      description: >-
        This operation shows limited details for all of your transcoders. For
        detailed information, fetch a single transcoder.
      operationId: listTranscoders
      tags:
        - transcoders
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transcoders'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
  /transcoders/{id}:
    get:
      summary: Fetch a transcoder
      description: This operation shows the details of a specific transcoder.
      operationId: showTranscoder
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    $ref: '#/components/schemas/transcoder'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    patch:
      summary: Update a transcoder
      description: This operation updates a transcoder.
      operationId: updateTranscoder
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/transcoders/2adffc17" \
              -d $'{
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname',
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transcoder_update_input'
        description: >-
          Provide the details of the transcoder to update in the body of the
          request.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    $ref: '#/components/schemas/transcoder'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      summary: Delete a transcoder
      description: >-
        This operation deletes a transcoder, including all of its assigned
        output renditions and stream targets. <br><br><b>Note</b>: You can't
        remove transcoders that have an asset_id. Assets must be removed by
        sending a DEL request to the /assets endpoint. 
      operationId: deleteTranscoder
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/transcoders/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{id}/enable_all_stream_targets:
    put:
      summary: Enable a transcoder's stream targets
      description: >-
        This operation enables all of the stream targets assigned to a specific
        transcoder.
      operationId: enableAllStreamTargetsTranscoder
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/enable_all_stream_targets"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/enable_all_stream_targets';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });

            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    type: object
                    title: transcoder
                    required:
                      - stream_targets
                    properties:
                      stream_targets:
                        type: object
                        title: stream_targets
                        properties:
                          state:
                            type: string
                            description: The state of the transcoder's stream targets.
                            example: enabled
                            enum:
                              - enabled
                              - disabled
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{id}/disable_all_stream_targets:
    put:
      summary: Disable a transcoder's stream targets
      description: >-
        This operation disables all of the stream targets assigned to a specific
        transcoder.
      operationId: disableAllStreamTargetsTranscoder
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/disable_all_stream_targets"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/disable_all_stream_targets';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });

            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    type: object
                    title: transcoder
                    required:
                      - stream_targets
                    properties:
                      stream_targets:
                        type: object
                        title: stream_targets
                        properties:
                          state:
                            type: string
                            description: The state of the transcoder's stream targets.
                            example: enabled
                            enum:
                              - enabled
                              - disabled
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{id}/start:
    put:
      summary: Start a transcoder
      description: This operation starts a transcoder.
      operationId: startTranscoder
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/start"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/start';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    type: object
                    title: transcoder
                    properties:
                      state:
                        type: string
                        description: The state of the transcoder.
                        example: starting
                        enum:
                          - starting
                          - stopping
                          - started
                          - stopped
                          - resetting
                      uptime_id:
                        type: string
                        description: >-
                          The unique identifier associated with a specific
                          uptime period of a transcoder.
                        example: abcd1234
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{id}/stop:
    put:
      summary: Stop a transcoder
      description: This operation stops a transcoder.
      operationId: stopTranscoder
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/stop"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/stop';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    type: object
                    title: transcoder
                    properties:
                      state:
                        type: string
                        description: The state of the transcoder.
                        example: starting
                        enum:
                          - starting
                          - stopping
                          - started
                          - stopped
                          - resetting
                      uptime_id:
                        type: string
                        description: >-
                          The unique identifier associated with a specific
                          uptime period of a transcoder.
                        example: abcd1234
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{id}/reset:
    put:
      summary: Reset a transcoder
      description: This operation resets a transcoder.
      operationId: resetTranscoder
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/reset"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/reset';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    type: object
                    title: transcoder
                    properties:
                      state:
                        type: string
                        description: The state of the transcoder.
                        example: resetting
                        enum:
                          - starting
                          - stopping
                          - started
                          - stopped
                          - resetting
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{id}/start_recording:
    put:
      summary: Start recording
      description: >-
        This operation starts the recording of a transcoder after the transcoder
        has started.

        If you want the recording to start and stop automatically when you start
        or stop the transcoder instead, set _recording_ to **true** when you
        create a transcoder or update a transcoder.
      operationId: startTranscoderRecording
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/start_recording"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/start_recording';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    type: object
                    title: transcoder
                    properties:
                      recording:
                        type: object
                        description: The recording for the transcoder.
                        properties:
                          state:
                            type: string
                            description: The state of video capture for the transcoder.
                            example: started
                            enum:
                              - started
                              - stopped
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{id}/stop_recording:
    put:
      summary: Stop recording
      description: >-
        This operation stops the recording of a transcoder before the transcoder
        has stopped. Wowza Video begins converting the recording to an MP4 file
        after the transcoder has stopped. You can use this operation to manually
        stop recording even if _recording_ is set to **true** on the transcoder,
        meaning the recording was automatically started at transcoder start.

        If you want the recording to start and stop automatically when you start
        and stop the transcoder, set _recording_ to **true** when you create a
        transcoder or  update a transcoder and then don't use the manual stop
        recording operation.
      operationId: stopTranscoderRecording
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/stop_recording"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/stop_recording';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    type: object
                    title: transcoder
                    properties:
                      recording:
                        type: object
                        description: The recording for the transcoder.
                        properties:
                          state:
                            type: string
                            description: The state of video capture for the transcoder.
                            example: stopped
                            enum:
                              - started
                              - stopped
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{id}/schedules:
    get:
      summary: Fetch transcoder's schedules
      description: >-
        This operation shows the details of all of the schedules for a specific
        transcoder.
      operationId: listTranscoderSchedules
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/schedules"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/schedules';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - schedules
                properties:
                  schedules:
                    type: array
                    description: >-
                      Array of schedules of this transcoder. See /schedules for
                      more details.
                    items:
                      $ref: '#/components/schemas/schedule'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /transcoders/{id}/thumbnail_url:
    get:
      summary: Fetch the thumbnail URL of a transcoder
      description: This operation shows the thumbnail URL of a started transcoder.
      operationId: showTranscoderThumbnailUrl
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/thumbnail_url"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/thumbnail_url';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    type: object
                    title: transcoder
                    properties:
                      thumbnail_url:
                        type: string
                        description: The URL to receive the preview thumbnail.
                        example: >-
                          https://cloud.wowza.com/proxy/stats/?target=10.11.12.13&app=app-B8P6K226&stream=99b62146@130135.stream&media=json
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /transcoders/{id}/state:
    get:
      summary: Fetch the state and uptime ID of a transcoder
      description: This operation shows the current state and uptime ID of a transcoder.
      operationId: showTranscoderState
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/state"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/state';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - transcoder
                properties:
                  transcoder:
                    type: object
                    title: transcoder
                    properties:
                      ip_address:
                        type: string
                        description: >-
                          The IP address of the transcoder instance. If the
                          transcoder *state* is anything other than **started**,
                          the *ip_address* is **0.0.0.0**.
                        example: 1.2.3.4
                      state:
                        type: string
                        description: The state of the transcoder.
                        example: started
                        enum:
                          - starting
                          - stopping
                          - started
                          - stopped
                          - resetting
                      uptime_id:
                        type: string
                        description: >-
                          The unique identifier associated with a specific
                          uptime period of a transcoder.
                        example: abcd1234
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /transcoders/{id}/vod_streams:
    get:
      summary: Fetch all VOD streams for a transcoder
      description: >-
        (Available from version 1.5) This operation shows the details of all VOD
        streams associated to a specific transcoder.
      operationId: listTranscoderVODStreams
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/vod_streams"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/vod_streams';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vod_streams'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /transcoders/{transcoder_id}/uptimes:
    get:
      summary: Fetch all uptime records for a transcoder
      description: >-
        This operation shows all of the uptime records for a specific
        transcoder. An *uptime record* identifies a specific transcoding
        session.
      operationId: indexUptimes
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/uptimes"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/uptimes';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/uptimes'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /transcoders/{transcoder_id}/uptimes/{id}:
    get:
      summary: Fetch an uptime record
      description: >-
        This operation shows the details of a specific uptime record for a
        specific transcoder. An *uptime record* identifies a transcoding
        session.
      operationId: showUptime
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/uptimes/1acfg43d"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/uptimes/1acfg43d';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the uptime record.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - uptime
                properties:
                  uptime:
                    $ref: '#/components/schemas/uptime'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /transcoders/{transcoder_id}/outputs:
    post:
      summary: Create an output
      description: >-
        This operation creates an output rendition for a specific transcoder.
        You can create up to 10 outputs per transcoder.
      operationId: createTranscoderOutput
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs" \
              -d $'{
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/outputs';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/output_create_input'
        description: >-
          Provide the details of the output rendition to create in the body of
          the request.
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - output
                properties:
                  output:
                    $ref: '#/components/schemas/output'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch all outputs of a transcoder
      description: >-
        This operation shows the details of all of the output renditions of a
        specific transcoder.
      operationId: listTranscoderOutputs
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/outputs';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/outputs'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /transcoders/{transcoder_id}/outputs/{id}:
    get:
      summary: Fetch an output
      description: >-
        This operation shows the details of a specific output rendition for a
        specific transcoder.
      operationId: showTranscoderOutput
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/outputs/1acfg43d';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - output
                properties:
                  output:
                    $ref: '#/components/schemas/output'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    patch:
      summary: Update an output
      description: This operation updates an output rendition.
      operationId: updateTranscoderOutput
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d" \
              -d $'{
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/outputs/1acfg43d';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname',
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }));
            req.end();
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/output_update_input'
        description: >-
          Provide the details of the output rendition to update in the body of
          the request.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - output
                properties:
                  output:
                    $ref: '#/components/schemas/output'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      summary: Delete an output
      description: This operation deletes an output, including all of its assigned targets.
      operationId: deleteTranscoderOutput
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/outputs/1acfg43d';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets:
    post:
      summary: Create an output stream target
      description: >-
        This operation creates an output stream target, assigning the stream
        target to the specified output rendition. 
      operationId: createTranscoderOutputOutputStreamTarget
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets" \
              -d $'{
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });

            req.write(JSON.stringify({
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }));

            req.end();
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: output_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/output_stream_target_create_input'
        description: >-
          Provide the details of the output stream target to create in the body
          of the request. 
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - output_stream_target
                properties:
                  output_stream_target:
                    $ref: '#/components/schemas/output_stream_target'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch all output stream targets of an output of a transcoder
      description: >-
        This operation shows the details of all of the output stream targets of
        an output of a transcoder.
      operationId: listTranscoderOutputOutputStreamTargets
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: output_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/output_stream_targets'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}:
    get:
      summary: Fetch an output stream target
      description: This operation shows the details of an output stream target.
      operationId: showTranscoderOutputOutputStreamTarget
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: output_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
        - name: stream_target_id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the stream target.


            **Tip:** If you're using both the primary and backup URL for a
            stream target, send *output_stream_target_id* in the path instead.
            *output_stream_target_id* was returned when you added the stream
            target to the ouput rendition. This allows you to differentiate
            between the primary and backup URL versions of the stream target.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  output_stream_target:
                    $ref: '#/components/schemas/output_stream_target'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    patch:
      summary: Update an output stream target
      description: This operation updates an output stream target.
      operationId: updateTranscoderOutputOutputStreamTarget
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77" \
              -d $'{
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }'
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname',
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });

            req.write(JSON.stringify({
              "transcoder": {
                "property": "My Value",
                "...": "..."
              }
            }));

            req.end();
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: output_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
        - name: stream_target_id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the stream target.


            **Tip:** If you're using both the primary and backup URL for a
            stream target, send *output_stream_target_id* in the path instead.
            *output_stream_target_id* was returned when you added the stream
            target to the ouput rendition. This allows you to differentiate
            between the primary and backup URL versions of the stream target.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/output_stream_target_update_input'
        description: >-
          Provide the details of the output stream target to update in the body
          of the request.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - output_stream_target
                properties:
                  output_stream_target:
                    $ref: '#/components/schemas/output_stream_target'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      summary: Delete an output stream target
      description: >-
        This operation deletes an output stream target, including all of its
        assigned targets.
      operationId: deleteTranscoderOutputOutputStreamTarget
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: output_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
        - name: stream_target_id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the stream target.


            **Tip:** If you're using both the primary and backup URL for a
            stream target, send *output_stream_target_id* in the path instead.
            *output_stream_target_id* was returned when you added the stream
            target to the ouput rendition. This allows you to differentiate
            between the primary and backup URL versions of the stream target.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/enable:
    put:
      summary: Enable an output stream target
      description: This operation enables an output stream target.
      operationId: enableTranscoderOutputOutputStreamTarget
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/enable"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/enable';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });

            req.end();
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: output_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
        - name: stream_target_id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the stream target.


            **Tip:** If you're using both the primary and backup URL for a
            stream target, send *output_stream_target_id* in the path instead.
            *output_stream_target_id* was returned when you added the stream
            target to the ouput rendition. This allows you to differentiate
            between the primary and backup URL versions of the stream target.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - stream_target
                properties:
                  stream_target:
                    type: object
                    title: stream_target
                    properties:
                      state:
                        type: string
                        description: The state of the output stream target.
                        example: enabled
                        enum:
                          - enabled
                          - disabled
                          - restarted
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/disable:
    put:
      summary: Disable an output stream target
      description: This operation disables an output stream target.
      operationId: disableTranscoderOutputOutputStreamTarget
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/disable"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/disable';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });

            req.end();
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: output_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
        - name: stream_target_id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the stream target.


            **Tip:** If you're using both the primary and backup URL for a
            stream target, send *output_stream_target_id* in the path instead.
            *output_stream_target_id* was returned when you added the stream
            target to the ouput rendition. This allows you to differentiate
            between the primary and backup URL versions of the stream target.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - stream_target
                properties:
                  stream_target:
                    type: object
                    title: stream_target
                    properties:
                      state:
                        type: string
                        description: The state of the output stream target.
                        example: disabled
                        enum:
                          - enabled
                          - disabled
                          - restarted
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets/{stream_target_id}/restart:
    put:
      summary: Restart an output stream target
      description: This operation restarts an output stream target.
      operationId: restartTranscoderOutputOutputStreamTarget
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/restart"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/restart';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });

            req.end();
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: output_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the output rendition.
          schema:
            type: string
        - name: stream_target_id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the stream target.


            **Tip:** If you're using both the primary and backup URL for a
            stream target, send *output_stream_target_id* in the path instead.
            *output_stream_target_id* was returned when you added the stream
            target to the ouput rendition. This allows you to differentiate
            between the primary and backup URL versions of the stream target.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - stream_target
                properties:
                  stream_target:
                    type: object
                    title: stream_target
                    properties:
                      state:
                        type: string
                        description: The state of the output stream target.
                        example: restarted
                        enum:
                          - enabled
                          - disabled
                          - restarted
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{transcoder_id}/properties:
    post:
      summary: Configure a property for a transcoder
      description: >-
        This operation configures a single property or an array of properties
        for a transcoder.


        For a comprehensive resource describing the use of advanced properties,
        see [Set advanced properties with the Wowza Video REST
        API](https://www.wowza.com/docs/how-to-set-advanced-properties-by-using-the-wowza-video-rest-api).
      operationId: createTranscoderProperty
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/properties" \
              -d $'{
              "property": {
                "key": "rtpIgnoreProfileLevelId",
                "section": "rtsp",
                "value": true
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/properties';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "property": {
                "key": "rtpIgnoreProfileLevelId",
                "section": "rtsp",
                "value": true
              }
            }));
            req.end();
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              required:
                - property
                - properties
              oneOf:
                - $ref: '#/components/schemas/transcoder_property_create_input'
                - $ref: '#/components/schemas/transcoder_properties_create_input'
        description: >-
          Provide the details of the property or properties to configure in the
          body of the request. You must include either *property* or
          *properties* in the request as the root object.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                required:
                  - property
                  - properties
                oneOf:
                  - $ref: >-
                      #/components/schemas/transcoder_configure_property_post_response
                  - $ref: >-
                      #/components/schemas/transcoder_configure_properties_post_response
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch a transcoder's properties
      description: This operation shows all of the properties of a specific transcoder.
      operationId: listTranscoderProperties
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/properties"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/transcoders/2adffc17/properties';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/transcoder_configure_properties_post_response
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /transcoders/{transcoder_id}/properties/{id}:
    get:
      summary: Fetch a property for a transcoder
      description: >-
        This operation shows the details of a specific property for a specific
        transcoder.
      operationId: showTranscoderProperty
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/properties/rtsp-rtpIgnoreProfileLevelId"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/properties/rtsp-rtpIgnoreProfileLevelId';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: >-
            The unique string that identifies the transcoder property. The
            string contains the section and the key, connected by a dash. For
            example, **cupertino-aes128Secret**.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/transcoder_configure_property_post_response
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    delete:
      summary: Delete a transcoder's property
      description: This operation deletes a specific property from a specific transcoder.
      operationId: deleteTranscoderProperty
      tags:
        - transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/transcoders/2adffc17/properties/cupertino-aes128Secret"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/transcoders/2adffc17/properties/cupertino-aes128Secret';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: transcoder_id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: >-
            The unique string that identifies the transcoder property. The
            string contains the section and the key, connected by a dash. For
            example, **cupertino-aes128Secret**.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/viewers/account:
    get:
      summary: Fetch viewer analytics data for an account
      description: >-
        (Available from version 1.11) This operation returns live and historic
        viewer data for the account related to the JSON web token used for API
        authentication. You'll use the query parameters to return live vs
        historic data, as well as specific types of viewer data. 


        **Querying live data**

        1. To get data for currently live streams, do not send **from** and
        **to** values.


        2. Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, devices, and trend data.


        If you don't send any query parameters (to, from, or include), the total
        number of viewers is returned.


        **Querying historic data**



        1. To get data for streams that ran previously, send **from** and **to**
        values.


        2. Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, devices, and trend data. 



        If you don't send **include** values, the total number of viewers is
        returned.

        If the time range between **from** and **to** query parameters is:
            
        <ul><li>Less than 60 minutes, the cache time between responses is 10
        seconds.</li> <li>More than 60 minutes, the cache time between responses
        is 60 seconds.</li> 
      operationId: analyticsAccountViewers
      tags:
        - analytics_viewers
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/viewers/account?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/viewers/account?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            Use this parameter, along with **to**, to return historic viewer
            data. 


            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second. If you set the
            **from** query parameter without setting the **to** query 
            parameter, the data returned will reflect 30 days starting at the
            **from** date, or  data up to to the current day, whichever is
            shorter.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            Use this parameter, along with **from**, to return historic viewer
            data. 



            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second. If you set the **to**
            query parameter without setting the **from** query parameter, the
            data returned will be from the past 30 days.



            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid values are: **countries**, **renditions**, **devices**, and
            **trend**.


            Example:

            **countries,trend**
          schema:
            type: string
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_viewers_account'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/viewers/live_streams/{id}:
    get:
      summary: Fetch viewer analytics data for a live stream
      description: >-
        (Available from version 1.11) This operation returns the live and
        historic viewer data for a specific live stream. You'll use the query
        parameters to return live vs historic data, as well as specific types of
        viewer data.


        **Querying live data**


        1. To get data for currently live streams, do not send **from** and
        **to** values.


        2. Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, devices, and trend data. 


        If you don't send any query parameters (to, from, or include), the total
        number of viewers is returned.


        **Querying historic data**


        1. To get data for streams that ran previously, send **from** and **to**
        values.


        2. Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, devices, and trend data. 



        If you don't send **include** values, the total number of viewers is
        returned.



        If the time range between **from** and **to** query parameters is:
            
        <ul><li>Less than 60 minutes, the cache time between responses is 10
        seconds.</li> <li>More than 60 minutes, the cache time between responses
        is 60 seconds.</li>
      operationId: analyticLivestreamViewers
      tags:
        - analytics_viewers
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/viewers/live_streams/tvctq36g?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/viewers/live_streams/tvctq36g?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            Use this parameter, along with **to**, to return historic viewer
            data. 


            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second. If you set the
            **from** query parameter without setting the **to** query 
            parameter, the data returned will reflect 30 days starting at the
            **from** date, or  data up to to the current day, whichever is
            shorter.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            Use this parameter, along with **from**, to return historic viewer
            data. 



            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second. If you set the **to**
            query parameter without setting the **from** query parameter, the
            data returned will be from the past 30 days.



            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid values are: **countries**, **renditions**, **devices**, and
            **trend**.


            Example:

            **countries,trend**
          schema:
            type: string
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_viewers_live_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/viewers/vod_streams/{id}:
    get:
      summary: Fetch viewer analytics data for a VOD stream
      description: >-
        (Available from version 1.11) This operation returns the live and
        historic viewer data for a specific VOD stream. You'll use the query
        parameters to return live vs historic data, as well as specific types of
        viewer data.


        **Querying live data**


        1. To get data for currently live streams, do not send **from** and
        **to** values.


        2. Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, devices, and trend data. 


        If you don't send any query parameters (to, from, or include), the total
        number of viewers is returned.


        **Querying historic data**


        1. To get data for streams that ran previously, send **from** and **to**
        values.


        2. Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, devices, and trend data. 


        If you don't send **include** values, the total number of viewers is
        returned.


        If the time range between **from** and **to** query parameters is:
            
        <ul><li>Less than 60 minutes, the cache time between responses is 10
        seconds.</li> <li>More than 60 minutes, the cache time between responses
        is 60 seconds.</li> 
      operationId: analyticsVodStreamViewers
      tags:
        - analytics_viewers
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/viewers/vod_streams/tvctq36g?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/viewers/vod_streams/tvctq36g?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the VOD stream.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            Use this parameter, along with **to**, to return historic viewer
            data. 


            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second. If you set the
            **from** query parameter without setting the **to** query 
            parameter, the data returned will reflect 30 days starting at the
            **from** date, or  data up to to the current day, whichever is
            shorter.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            Use this parameter, along with **from**, to return historic viewer
            data. 



            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second. If you set the **to**
            query parameter without setting the **from** query parameter, the
            data returned will be from the past 30 days.



            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid values are: **countries**, **renditions**, **devices**, and
            **trend**.


            Example:

            **countries,trend**
          schema:
            type: string
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_viewers_vod_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/viewers/stream_targets/{id}:
    get:
      summary: Fetch viewer analytics data for a stream target
      description: >-
        (Available from version 1.11) This operation returns the live and
        historic viewer data for a specific stream target. You'll use the query
        parameters to return live vs historic data, as well as specific types of
        viewer data.


        **Querying live data**


        1. To get data for currently live streams, do not send **from** and
        **to** values.


        2. Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, devices, and trend data. 


         If you don't send any query parameters (to, from, or include), the total number of viewers is returned.


        **Querying historic data**


        1. To get data for streams that ran previously, send **from** and **to**
        values.


        2. Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, devices, and trend data. 


        If you don't send **include** values, the total number of viewers is
        returned.


        If the time range between **from** and **to** query parameters is:
            
        <ul><li>Less than 60 minutes, the cache time between responses is 10
        seconds.</li> <li>More than 60 minutes, the cache time between responses
        is 60 seconds.</li>
      operationId: analyticsStreamTargetViewers
      tags:
        - analytics_viewers
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/viewers/stream_targets/tvctq36g?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/viewers/stream_targets/tvctq36g?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            Use this parameter, along with **to**, to return historic viewer
            data. 


            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second. If you set the
            **from** query parameter without setting the **to** query 
            parameter, the data returned will reflect 30 days starting at the
            **from** date, or  data up to to the current day, whichever is
            shorter.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            Use this parameter, along with **from**, to return historic viewer
            data. 



            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second. If you set the **to**
            query parameter without setting the **from** query parameter, the
            data returned will be from the past 30 days.



            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid values are: **countries**, **renditions**, **devices**, and
            **trend**.


            Example:

            **countries,trend**
          schema:
            type: string
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_viewers_stream_target'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/viewers/live_streams:
    get:
      summary: Fetch viewer analytics data for the most viewed live streams
      description: >-
        (Available from version 1.11) This operation returns viewer data for the
        top 100 live streams in an account.


          **Querying data**


          To get viewer data for the top 100 streams that ran previously, send **from** and **to** values.


          If you do not send **from** and **to** values, the last five minutes' worth of live stream viewer data is returned.


          If the time range between **from** and **to** query parameters is:
            
          <ul><li>Less than 60 minutes, the cache time between responses is 10 seconds.</li>
          <li>More than 60 minutes, the cache time between responses is 60 seconds.</li>
      operationId: analyticsLiveStreamsViewers
      tags:
        - analytics_viewers
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/viewers/live_streams?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z"
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/viewers/live_streams?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            Use this parameter, along with **to**, to return historic viewer
            data. 


            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second. If you set the
            **from** query parameter without setting the **to** query 
            parameter, the data returned will reflect 30 days starting at the
            **from** date, or  data up to to the current day, whichever is
            shorter.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            Use this parameter, along with **from**, to return historic viewer
            data. 



            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second. If you set the **to**
            query parameter without setting the **from** query parameter, the
            data returned will be from the past 30 days.



            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_viewers_live_streams'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/viewers/vod_streams:
    get:
      summary: Fetch viewer analytics data for the most viewed VOD streams
      description: >-
        (Available from version 1.11) This operation returns viewer data for the
        top 100 VOD streams in an account.


        **Querying data**


        To get viewer data for the top 100 streams that ran previously, send
        **from** and **to** values.


        If you do not send **from** and **to** values, the last five minutes'
        worth of VOD stream viewer data is returned.


        If the time range between **from** and **to** query parameters is:
            
        <ul><li>Less than 60 minutes, the cache time between responses is 10
        seconds.</li> <li>More than 60 minutes, the cache time between responses
        is 60 seconds.</li>
      operationId: analyticsVodStreamsViewers
      tags:
        - analytics_viewers
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/viewers/vod_streams?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z"
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/viewers/vod_streams?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            Use this parameter, along with **to**, to return historic viewer
            data. 


            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second. If you set the
            **from** query parameter without setting the **to** query 
            parameter, the data returned will reflect 30 days starting at the
            **from** date, or  data up to to the current day, whichever is
            shorter.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            Use this parameter, along with **from**, to return historic viewer
            data. 



            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second. If you set the **to**
            query parameter without setting the **from** query parameter, the
            data returned will be from the past 30 days.



            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_viewers_vod_streams'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/viewers/account/total:
    get:
      summary: Fetch total viewers analytics data for an account
      description: >-
        (Available from version 2.0) This operation returns the total viewers
        data for the account related to the JSON web token used for API
        authentication.


        **Querying data**


        Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, and devices.


        If you don't send the **include** query parameter, the total number of
        viewers is returned.
      operationId: analyticsAccountTotalViewers
      tags:
        - analytics_viewers
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
               "${WV_HOST}/api/beta/analytics/viewers/account/total?include=countries,renditions,devices"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/viewers/account/total?include=countries,renditions,devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid values are: **countries**, **renditions**, and **devices**.


            Example: **countries**
          schema:
            type: string
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_viewers_account_total'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/viewers/live_streams/{id}/total:
    get:
      summary: Fetch total viewers analytics data for a live stream
      description: >-
        (Available from version 2.0) This operation returns the total viewers
        data for a specific live stream.


        **Querying data**


        Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, and devices.


        If you don't send the **include** query parameter, the total number of
        viewers is returned.
      operationId: analyticLivestreamTotalViewers
      tags:
        - analytics_viewers
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/viewers/live_streams/tvctq36g/total?include=countries,renditions,devices"
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/viewers/live_streams/tvctq36g/total?include=countries,renditions,devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid values are: **countries**, **renditions**, and **devices**.


            Example:

            **countries**
          schema:
            type: string
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_viewers_live_stream_total'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/viewers/vod_streams/{id}/total:
    get:
      summary: Fetch total viewers analytics data for a VOD stream
      description: >-
        (Available from version 2.0) This operation returns the total viewers
        data for a specific VOD stream.

         **Querying data**


        Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, and devices.


        If you don't send the **include** query parameter, the total number of
        viewers is returned.
      operationId: analyticsVodStreamTotalViewers
      tags:
        - analytics_viewers
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/viewers/vod_streams/tvctq36g/total?include=countries,renditions,devices"
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/viewers/vod_streams/tvctq36g/total?include=countries,renditions,devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the VOD stream.
          schema:
            type: string
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid values are: **countries**, **renditions**, and **devices**.


            Example:

            **countries**
          schema:
            type: string
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_viewers_vod_stream_total'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/viewers/stream_targets/{id}/total:
    get:
      summary: Fetch total viewers analytics data for a stream target
      description: >-
        (Available from version 2.0) This operation returns the total viewers
        data for a specific stream target.

         **Querying data**


        Use the **include** query parameter to specify what data you want to
        return, including: countries, renditions, and devices.


        If you don't send the **include** query parameter, the total number of
        viewers is returned.
      operationId: analyticsStreamTargetTotalViewers
      tags:
        - analytics_viewers
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/viewers/stream_targets/tvctq36g/total?include=countries,renditions,devices"
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/viewers/stream_targets/tvctq36g/total?include=countries,renditions,devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid values are: **countries**, **renditions**, and **devices**.


            Example:

            **countries**
          schema:
            type: string
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_viewers_stream_target_total'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/ingest/live_streams/{id}:
    get:
      summary: Fetch ingest analytics data for a live stream
      description: >-
        (Available from version 1.11) This operation returns the ingest data for
        a specific live stream. You'll use the query parameters to return live
        vs historic data, as well as specific types of ingest data. 



        **Querying live data**


        To get data for currently live streams, do not send **include**,
        **from**, and **to** values.


        This operation returns a hash of metrics keys, each of which identifies
        a status, text description, unit, and value. 


        **Querying historic data**


        To get data for streams that ran previously, send **include**, **from**,
        and **to** values. 


        This operation returns a hash of metrics keys, each of which identifies
        a status, text description, unit, and value in addition to trend data.
      operationId: analyticLivestreamIngest
      tags:
        - analytics_ingest
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/ingest/live_streams/tvctq36g?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z&include=trend"
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/ingest/live_streams/tvctq36g?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the live stream.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            Use this parameter, along with **to**, to return historic viewer
            data. 


            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. 
            The range queried includes minutes and seconds. If you include
            seconds, Wowza Video rounds down to the minute. The maximum
            difference between **from** and **to** is 90 days. If you set the
            **from** query parameter without setting the **to** query parameter,
            the data returned will reflect 90 days starting at the **from**
            date, or data up to to the current day, whichever is shorter.


            Example:

            **2023-01-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            Use this parameter, along with **from**, to return historic viewer
            data. 



            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ** where **HH** is a 24-hour clock in UTC.  The range
            queried includes minutes and seconds. If you include seconds, Wowza
            Video rounds down to the minute. The maximum difference between
            **from** and **to** is 90 days. If you set the **to** query
            parameter without setting the **from** query parameter, the data
            returned will be from the past 90 days or from your last invoice
            date, whichever is shorter.


            Example:

            **2023-02-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            Specify the data you want returned in the response.

            Valid value is: **trend**.

            Example:
            **trend**
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_ingest_live_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /usage/account:
    get:
      summary: Fetch usage for an account
      description: >-
        (Available from version 1.8) This operation returns CDN usage details
        for the account related to the JSON web token used for API
        authentication. Defaults: from = last billing date, to = end of current
        day.
      operationId: showUsageAccountIndex
      tags:
        - usage_account
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/usage/accounts"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/usage/accounts';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: filter
          in: query
          required: false
          description: >-
            Restricts the data that gets returned by filtering on one or more
            values associated with a field. Construct a filter using a two-part
            expression that specifies the field on which to filter and the logic
            to use to filter.

            Keep in mind the following for account trend filters:
             <ul><li>The only valid filter is **resource**.</li>
             <li>The only valid filter operators are **eq** with values of **transcoders** or **vod_streams** or **in** with a value of **transcoders,vod_streams**. </li>
             <li>Filters use a zero-based index.</li></ul>

             For example:
              **filter[0][field]=resource&filter[0][eq]=vod_streams**
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-MM-DD HH:00:00** where **HH** is a 24-hour clock in UTC. The
            range doesn't include minutes and seconds and rounds minutes up to
            the hour. The maximum difference between **from** and **to** is 90
            days. If you set the **from** query parameter without setting the
            **to** query parameter, the data returned will reflect 90 days
            starting at the **from** date, or data up to to the current day,
            whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: last billing date
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-MM-DD
            HH:00:00** where **HH** is a 24-hour clock in UTC. The range doesn't
            include minutes and seconds and rounds minutes up to the hour. The
            maximum difference between **from** and **to** is 90 days. If you
            set the **to** query parameter without setting the **from** query
            parameter, the data returned will be from the past 90 days or from
            your last invoice date, whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: end of the current day
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid value is: **trend**.


            Example:

            **trend**
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage_account'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/engagement/vod_streams/{id}:
    get:
      summary: Fetch engagement analytics data for a VOD stream
      description: >-
        (Available from version 1.11) This operation returns the engagement data
        for a specific VOD stream. Engagement data provides insight into how
        many plays your stream received and for how long. 


        If you don't send from and to query parameters, the last hour's worth of
        data is returned. See the **trend** field in the response for
        information about sample intervals.


        If the time range between **from** and **to** query parameters is:
            
        <ul><li>Less than 60 minutes, the cache time between responses is 10
        seconds.</li> <li>More than 60 minutes, the cache time between responses
        is 60 seconds.</li>
      operationId: analyticsVodStreamEngagement
      tags:
        - analytics_engagement
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/popularity/vod_streams/tvctq36g?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z&include=trend"
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/engagement/vod_streams/tvctq36g?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the VOD stream.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            Use this parameter, along with **to**, to return historic viewer
            data. 


            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ** where **HH**  is a 24-hour clock in UTC.
            The range queried is rounded to the nearest second. If you set the 
            **from** query parameter without setting the **to** query parameter,
            the data returned will  reflect 30 days starting at the **from**
            date, or data up to to the current day, whichever is shorter.


            Example:

            **2024-04-13T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            Use this parameter, along with **from**, to return historic viewer
            data. 



            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second. If you set the **to**
            query parameter without setting the **from** query parameter, the
            data returned will be from the past 30 days.


            Example:

            **2023-02-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. The only valid
            value for this endpoint is **trend**.


            Valid values are: trend


            Example:

            **trend**
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_engagement_vod_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/popularity/live_streams/{id}:
    get:
      summary: Fetch popularity analytics data for a live stream or real-time stream
      description: >-
        (Available from version 1.11) This operation returns the popularity data
        for a specific live stream or real-time stream. Popularity data provides
        insight into how many times your stream is displayed to a possible
        viewer and how many times it's played. 


        If you don't send from and to query parameters, the last hour's worth of
        data is returned. 


        Use the include query parameter to specify whether you want to return
        trend data. See the **trend** field in the response for information
        about sample intervals.


        If the time range between **from** and **to** query parameters is:
            
        <ul><li>Less than 60 minutes, the cache time between responses is 10
        seconds.</li> <li>More than 60 minutes, the cache time between responses
        is 60 seconds.</li>
      operationId: analyticsLivestreamPopularity
      tags:
        - analytics_popularity
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/popularity/live_streams/tvctq36g?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z&include=trend"
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/popularity/live_streams/tvctq36g?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the live stream or
            real-time stream.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            Use this parameter, along with **to**, to return historic viewer
            data. 


            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second. If you set the
            **from** query parameter without setting the **to** query 
            parameter, the data returned will reflect 30 days starting at the
            **from** date, or  data up to to the current day, whichever is
            shorter.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            Use this parameter, along with **from**, to return historic viewer
            data. 



            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second. If you set the **to**
            query parameter without setting the **from** query parameter, the
            data returned will be from the past 30 days.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. he only valid
            value for this endpoint is **trend**.


            Valid value is: **trend**.


            Example:

            **trend**
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_popularity_live_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/popularity/vod_streams/{id}:
    get:
      summary: Fetch popularity analytics data for a VOD stream
      description: >-
        (Available from version 1.11) This operation returns the popularity data
        for a specific VOD stream. Popularity data provides insight into how
        many times  your video is displayed to a possible viewer and how many
        times it's played. 


        If you don't send from and to query parameters, the last hour's worth of
        data is returned. See the **trend** field in the response for
        information about sample intervals.


        Use the include query parameter to specify whether you want to return
        trend data. See the **trend** field in the response for information
        about sample intervals.


        If the time range between **from** and **to** query parameters is:
            
        <ul><li>Less than 60 minutes, the cache time between responses is 10
        seconds.</li> <li>More than 60 minutes, the cache time between responses
        is 60 seconds.</li>
      operationId: analyticsVodStreamPopularity
      tags:
        - analytics_popularity
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/popularity/vod_streams/tvctq36g?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z&include=trend"
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/popularity/vod_streams/tvctq36g?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the VOD stream.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            Use this parameter, along with **to**, to return historic viewer
            data. 


            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second. If you set the
            **from** query parameter without setting the **to** query 
            parameter, the data returned will reflect 30 days starting at the
            **from** date, or  data up to to the current day, whichever is
            shorter.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            Use this parameter, along with **from**, to return historic viewer
            data. 



            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second. If you set the **to**
            query parameter without setting the **from** query parameter, the
            data returned will be from the past 30 days.



            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. The only valid
            value for this endpoint is **trend**.


            Valid value is: **trend**.


            Example:

            **trend**
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_popularity_vod_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/error_density/account:
    get:
      summary: Fetch error density metrics for an account
      description: >-
        (Available from version 2.0) This operation returns the error density
        metrics for all streams within the account related to the JSON web token
        used for API authentication.
      operationId: analyticsQoeErrorDensityAccount
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/error_density/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/error_density/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The trend data you want returned in the response.

            Valid value is **trend**.

            Example:
            **trend**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: include_recoverable
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specifies whether recoverable (non-fatal) playback errors should be
            included in the response. Default is `false`. 
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_error_density_account'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/error_density/media/{id}:
    get:
      summary: Fetch error density metrics for specific streams
      description: >-
        (Available from version 2.0) This operation returns the error density
        metrics for specific streams.
      operationId: analyticsQoeErrorDensityMedia
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/error_density/media/7ced08dd-a744-4944-bb87-019979cb3597?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/error_density/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the stream. Send a
            comma-separated list of live stream and/or video **id**s to request
            error density data for specific live streams and/or videos.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.

            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            Specify the data you want returned in the response.

            Valid value is **trend**.

            Example:
            **trend**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**



            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: include_recoverable
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specifies whether recoverable (non-fatal) playback errors should be
            included in the response. Default is `false`. 
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_error_density_media_{id}'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/error_free_sessions/account:
    get:
      summary: Fetch error free sessions percentage for all the streams in the account
      description: >-
        (Available from version 2.0) This operation returns the percentage of
        error free sessions for all the streams within the account related to
        the JSON web token used for API authentication.
      operationId: analyticsQoeErrorFreeSessions
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/error_free_sessions/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/error_free_sessions/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The device data you want returned in the response.

            Valid value is **trend**.

            Example:
            **trend**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: include_recoverable
          in: query
          required: false
          schema:
            type: boolean
          description: |-
            Include recoverable errors in the response.
            Example: **true**
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_error_free_sessions_account'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/error_free_sessions/media/{id}:
    get:
      summary: Fetch error free sessions percentage for specific streams
      description: >-
        (Available from version 2.0) This operation returns the percentage of
        sessions that were error-free for specific streams.
      operationId: analyticsQoeErrorFreeSessionsMedia
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/error_free_sessions/media/abc123?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/error_free_sessions/media/abc123?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the stream. Send a
            comma-separated list of stream **id**s to request error free
            sessions percentage data for specific streams.
          schema:
            type: string
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The device data you want returned in the response.

            Valid value is **devices**.

            Example:
            **devices**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: include_recoverable
          in: query
          required: false
          schema:
            type: boolean
          description: |-
            Include recoverable errors in the response.
            Example: **true**
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/analytics_qoe_error_free_sessions_media_media_ids
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/errors/drilldown:
    get:
      summary: Fetch error drill down metrics for your streams
      description: >-
        (Available from version 2.0) This operation returns the error drill down
        by device metrics for all the live streams and videos within the account
        related to the JSON web token used for API authentication.
      operationId: analyticsQoeErrorRateDrilldown
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/errors/drilldown/?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/errors/drilldown?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest second.

            Example: **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest second.

            Example: **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.

            Example: **Desktop**



            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: media_ids
          in: query
          required: false
          schema:
            type: string
          description: >-
            A comma separated list of IDs of the streams you want the returned
            data to reflect.

            If **media_ids** aren't specified, then the pagination parameters,
            **limit** and **page**, are used instead to determine returned
            results.

            Example: **abcd1234,wxyz3457**
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          description: |-
            Specify the metric used to sort the returned objects.
            Example: **total_count**
            Enum: `"total_count"` `"session_count"`
        - name: sort_by_order
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
          description: |-
            Sort the results in ascending (`asc`) or descending (`desc`) order.
            Default: **desc**
            Example: **asc**
        - name: error_type
          in: query
          required: false
          schema:
            type: string
          description: |-
            Filter results by a specific type of error.
            Example: **Playback**
        - name: include_recoverable
          in: query
          required: false
          schema:
            type: boolean
          description: |-
            Include recoverable errors in the response.
            Example: **true**
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Specify the number of results to return per page. The maximum number
            of results per page is 20. The default is 10. The minimum value is
            1.

            Example: **15**
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Returns a paginated view of results. Specify a positive integer to
            indicate which page of the results should be displayed.

            Pagination is determined according to the following logic:

            - If page=0, rows 1–10 are returned - If page=1, rows 11–20 are
            returned

            Example: **2**
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_errors_drilldown'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/errors/drilldown_trend/{error_code}:
    get:
      summary: Fetch errors drill down trend metrics for your streams
      description: >-
        (Available from version 2.0) This operation returns the errors drill
        down trend metrics for all the streams within the account related to the
        JSON web token used for API authentication.
      operationId: analyticsQoeErrorRateDrilldownTrend
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/errors/drilldown/trend/02-01?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/errors/drilldown_trend/02-01?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: error_code
          in: path
          required: true
          description: >-
            The unique identifier that represents a specific playback error. See
            this <a
            href="https://try.flowplayer.com/?channel=stable#0=N4IgtglgJlA2CmIBcBWADAGhAZ3ggxgC7xTIgB0+22IW+A9rPQE5nMDmARgBQDMAHBnRCAbAEpaIQgAt4YREnABDYswhLYAWgAOG+ADsI7aYUmwlAT3oBXU4qW36k5vGwQAXvCWcEyQs2t4LBIIQm9fJH9ArEJ6Rk4lVkiAoJAAMwgEABVvGmTokFgIfQBrHM48qNTsaUT4ACFbWP0-FKwXJiUoRsJm1oKGfWxGBSqsB1iAJTx6Lv7UifppzqgAETxLZAAWNEwQRYAxenxrPLSNXHHHAAl4IxNkc9hLnHxmRlhkAG1MNABdLAZBB5L6gfRKeRkbQuABuEHgAHdJINiPo7CAQABfDBgiEKKT0EoGcgAKxodHoaIM6IRxSg9AR5AA+kyDgAZADyAHUAApsgCCAE0AKKTJlZDkAaWFADkALwAHRA8AsAClmEouQBFCAciCqrUAZRJUBlxukKCg7gAsrwtWB+BA2QBhVVoeAADX5uv1koAagBGHUu1XSTgAcXwPtVBwAqu4AJIBmX6gCc5BVqpJCZJ9HhAdpgq5MuwHudCZEKYAHvgE2BYCUyxWywbjabzZabXawKna-o0E7Xdp8LxrdHwxHU7x8OGq7IuX6LAn++Q-arrtd9F5w4bw6sufRBcwtiJDfh+at2Ch6uH+WhrvzmPxDbwPVlVQAmNLsNn0VOaGVCAALX4bRDQ-EQPTCLUSnwVN6Hqa4uWgcwIAgKt6GkfhhWYBEoGYElrQ5egPy1epJQRJUAG5JGkaAoAMeZsVxSFFFJckQBRakyA5TgSXgIgMzRNRXG4NImARbRzAseBmAzZh3mYbAxHINIWGFJR8GkbhuC+IkLAwAACBgGL+MQ5QAPkM4AFX0QzjMpbBCEM-ThQQOVDPpE55DRSgXBUeA3LkaluCVbBdH0JUxFs+zBichyGKCwyPK86wfMIPyvGIIL0tCnAIqimKHKGZywh8eBks8440upch2HgQgcupeolygPLZMUzQTNcQq7JclUgvIYgq0IZ1KVRZyPP0orusG4bRvG6lKu6oqyoQcglG0bQDDa1yECM2aEGi-RMQkLBcAIQgIEcsgUCQD9+CxHEQHBViKCoDiuLRMgAGIOpYLr6AY7BrKKqAIHC6SkEM9g1CgKiith6BNGIMApICwHYDSoZoYDNJmEMvHmCowyAHoACpDOFABHawNEM2koBkBysbAIZDPJ0nEc26GPzQbQqxJinDMNXR8AqzgGoReADBZ7GQc52zMUkC6BKum7FC2JAAyelj8XIEx62RRbvsUWyAB5wZhQzoEVZUFIB7rsCVCyiot0mrYslW8DV66hjIAMkC2LEAUKYoShBPWyE4IGLEkaxmE+RQTEIbRsCQUnSf8CxVIk9GZLkhgwFJgI0QgeRNCgRISkoahJEICxtrIJyLF8LA6JgRj8ngZiXrxMh6BhbR48TsgU7TjPSfwKB9Fzhl89kyh6GLjovFwbBSfBK6YXgUneFJpzwl3qTrHYYoN8H7RyEgWeyXrxv8WwN4IG0Ux2-oruql7178WkZ4R6TiAce6dM7T1nuJee0lF5FxLj7JQ69N4qAgDvPeB81rHyxmfIYpM-7YGvsUdi98m6KCfmoV+tEP4tG7t-fuigIGSSgawLACdAHAMnmAueDDLDQOXrAhA8DXCIO3rvfeh9yoe3gOcawsBCCk3oQvOSN9CExAfs3Z+5D36dyoV-Z6P8yDyMYbXDiLCx69AnqAmenCFFLxXnAhBW9kEiLQUfNBrdd4GO4YXOuKjiE4Abm3IBlCmJ-ExEAA">list</a>
            for all the available error codes in Wowza Flowplayer.



            Example:

            **02-37**
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The device data you want returned in the response.

            Valid value is **devices**.

            Example:
            **devices**
          schema:
            type: string
        - name: error_type
          in: query
          required: false
          schema:
            type: string
          description: |-
            Filter results by a specific type of error.
            Example: **Playback**
        - name: include_recoverable
          in: query
          required: false
          schema:
            type: boolean
          description: |-
            Include recoverable errors in the response.
            Example: **true**
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: media_ids
          in: query
          required: false
          schema:
            type: string
          description: >-
            A comma separated list of IDs of the streams you want the returned
            data to reflect. 


            If **media_ids** aren't specified, then the pagination parameters,
            **limit** and **page**, are used instead to determine returned
            results. 


            Example: **abcd1234,wxyz3457**
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/analytics_qoe_errors_drilldown_trend_error_code
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/errors/detail/media/{error_code}:
    get:
      summary: Fetch affected media assets by specific error code
      description: >-
        (Available from version 2.0) This operation returns a list of media
        assets impacted by a specified error, including the number of times each
        asset was impacted.
      operationId: analyticsQoeErrorsDetailMedia
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/errors/detail/media/:error_code/?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/errors/detail/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: error_code
          in: path
          required: true
          description: >-
            The unique identifier that represents a specific playback error. See
            this <a
            href="https://try.flowplayer.com/?channel=stable#0=N4IgtglgJlA2CmIBcBWADAGhAZ3ggxgC7xTIgB0+22IW+A9rPQE5nMDmARgBQDMAHBnRCAbAEpaIQgAt4YREnABDYswhLYAWgAOG+ADsI7aYUmwlAT3oBXU4qW36k5vGwQAXvCWcEyQs2t4LBIIQm9fJH9ArEJ6Rk4lVkiAoJAAMwgEABVvGmTokFgIfQBrHM48qNTsaUT4ACFbWP0-FKwXJiUoRsJm1oKGfWxGBSqsB1iAJTx6Lv7UifppzqgAETxLZAAWNEwQRYAxenxrPLSNXHHHAAl4IxNkc9hLnHxmRlhkAG1MNABdLAZBB5L6gfRKeRkbQuABuEHgAHdJINiPo7CAQABfDBgiEKKT0EoGcgAKxodHoaIM6IRxSg9AR5AA+kyDgAZADyAHUAApsgCCAE0AKKTJlZDkAaWFADkALwAHRA8AsAClmEouQBFCAciCqrUAZRJUBlxukKCg7gAsrwtWB+BA2QBhVVoeAADX5uv1koAagBGHUu1XSTgAcXwPtVBwAqu4AJIBmX6gCc5BVqpJCZJ9HhAdpgq5MuwHudCZEKYAHvgE2BYCUyxWywbjabzZabXawKna-o0E7Xdp8LxrdHwxHU7x8OGq7IuX6LAn++Q-arrtd9F5w4bw6sufRBcwtiJDfh+at2Ch6uH+WhrvzmPxDbwPVlVQAmNLsNn0VOaGVCAALX4bRDQ-EQPTCLUSnwVN6Hqa4uWgcwIAgKt6GkfhhWYBEoGYElrQ5egPy1epJQRJUAG5JGkaAoAMeZsVxSFFFJckQBRakyA5TgSXgIgMzRNRXG4NImARbRzAseBmAzZh3mYbAxHINIWGFJR8GkbhuC+IkLAwAACBgGL+MQ5QAPkM4AFX0QzjMpbBCEM-ThQQOVDPpE55DRSgXBUeA3LkaluCVbBdH0JUxFs+zBichyGKCwyPK86wfMIPyvGIIL0tCnAIqimKHKGZywh8eBks8440upch2HgQgcupeolygPLZMUzQTNcQq7JclUgvIYgq0IZ1KVRZyPP0orusG4bRvG6lKu6oqyoQcglG0bQDDa1yECM2aEGi-RMQkLBcAIQgIEcsgUCQD9+CxHEQHBViKCoDiuLRMgAGIOpYLr6AY7BrKKqAIHC6SkEM9g1CgKiith6BNGIMApICwHYDSoZoYDNJmEMvHmCowyAHoACpDOFABHawNEM2koBkBysbAIZDPJ0nEc26GPzQbQqxJinDMNXR8AqzgGoReADBZ7GQc52zMUkC6BKum7FC2JAAyelj8XIEx62RRbvsUWyAB5wZhQzoEVZUFIB7rsCVCyiot0mrYslW8DV66hjIAMkC2LEAUKYoShBPWyE4IGLEkaxmE+RQTEIbRsCQUnSf8CxVIk9GZLkhgwFJgI0QgeRNCgRISkoahJEICxtrIJyLF8LA6JgRj8ngZiXrxMh6BhbR48TsgU7TjPSfwKB9Fzhl89kyh6GLjovFwbBSfBK6YXgUneFJpzwl3qTrHYYoN8H7RyEgWeyXrxv8WwN4IG0Ux2-oruql7178WkZ4R6TiAce6dM7T1nuJee0lF5FxLj7JQ69N4qAgDvPeB81rHyxmfIYpM-7YGvsUdi98m6KCfmoV+tEP4tG7t-fuigIGSSgawLACdAHAMnmAueDDLDQOXrAhA8DXCIO3rvfeh9yoe3gOcawsBCCk3oQvOSN9CExAfs3Z+5D36dyoV-Z6P8yDyMYbXDiLCx69AnqAmenCFFLxXnAhBW9kEiLQUfNBrdd4GO4YXOuKjiE4Abm3IBlCmJ-ExEAA">list</a>
            for all the available error codes in Wowza Flowplayer.



            Example:

            **02-37**
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The device data you want returned in the response.

            Valid value is **devices**.

            Example:
            **devices**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: media_ids
          in: query
          required: false
          schema:
            type: string
          description: >-
            A comma separated list of IDs of the streams you want the returned
            data to reflect. 


            If **media_ids** aren't specified, then the pagination parameters,
            **limit** and **page**, are used instead to determine returned
            results. 


            Example: **abcd1234,wxyz3457**
        - name: include_recoverable
          in: query
          required: false
          schema:
            type: boolean
          description: |-
            Include recoverable errors in the response.
            Example: **true**
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Specify the number of results to return per page. The maximum number
            of results per page is 20. The default is 10.  The minimum value is
            1. 


            Example: **15**
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Returns a paginated view of results. Specify a positive integer to
            indicate which page of the results should be displayed.


            Pagination is determined according to the following logic:


            - If page=0, rows 1-10 are returned


            - If page=1, rows 11-20 are returned


            Example: **2**
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/analytics_qoe_errors_detail_media_error_code
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/errors/detail/message/{error_code}:
    get:
      summary: Fetch top error messages by error code
      description: >-
        (Available from version 2.0) This operation returns a list of the most
        frequent error messages associated with a specified error code,
        including the number of times each message occurred.
      operationId: analyticsQoeErrorsDetailMessage
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/errors/detail/message/:error_code/?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/errors/detail/message/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: error_code
          in: path
          required: true
          description: >-
            The unique identifier that represents a specific playback error. See
            this <a
            href="https://try.flowplayer.com/?channel=stable#0=N4IgtglgJlA2CmIBcBWADAGhAZ3ggxgC7xTIgB0+22IW+A9rPQE5nMDmARgBQDMAHBnRCAbAEpaIQgAt4YREnABDYswhLYAWgAOG+ADsI7aYUmwlAT3oBXU4qW36k5vGwQAXvCWcEyQs2t4LBIIQm9fJH9ArEJ6Rk4lVkiAoJAAMwgEABVvGmTokFgIfQBrHM48qNTsaUT4ACFbWP0-FKwXJiUoRsJm1oKGfWxGBSqsB1iAJTx6Lv7UifppzqgAETxLZAAWNEwQRYAxenxrPLSNXHHHAAl4IxNkc9hLnHxmRlhkAG1MNABdLAZBB5L6gfRKeRkbQuABuEHgAHdJINiPo7CAQABfDBgiEKKT0EoGcgAKxodHoaIM6IRxSg9AR5AA+kyDgAZADyAHUAApsgCCAE0AKKTJlZDkAaWFADkALwAHRA8AsAClmEouQBFCAciCqrUAZRJUBlxukKCg7gAsrwtWB+BA2QBhVVoeAADX5uv1koAagBGHUu1XSTgAcXwPtVBwAqu4AJIBmX6gCc5BVqpJCZJ9HhAdpgq5MuwHudCZEKYAHvgE2BYCUyxWywbjabzZabXawKna-o0E7Xdp8LxrdHwxHU7x8OGq7IuX6LAn++Q-arrtd9F5w4bw6sufRBcwtiJDfh+at2Ch6uH+WhrvzmPxDbwPVlVQAmNLsNn0VOaGVCAALX4bRDQ-EQPTCLUSnwVN6Hqa4uWgcwIAgKt6GkfhhWYBEoGYElrQ5egPy1epJQRJUAG5JGkaAoAMeZsVxSFFFJckQBRakyA5TgSXgIgMzRNRXG4NImARbRzAseBmAzZh3mYbAxHINIWGFJR8GkbhuC+IkLAwAACBgGL+MQ5QAPkM4AFX0QzjMpbBCEM-ThQQOVDPpE55DRSgXBUeA3LkaluCVbBdH0JUxFs+zBichyGKCwyPK86wfMIPyvGIIL0tCnAIqimKHKGZywh8eBks8440upch2HgQgcupeolygPLZMUzQTNcQq7JclUgvIYgq0IZ1KVRZyPP0orusG4bRvG6lKu6oqyoQcglG0bQDDa1yECM2aEGi-RMQkLBcAIQgIEcsgUCQD9+CxHEQHBViKCoDiuLRMgAGIOpYLr6AY7BrKKqAIHC6SkEM9g1CgKiith6BNGIMApICwHYDSoZoYDNJmEMvHmCowyAHoACpDOFABHawNEM2koBkBysbAIZDPJ0nEc26GPzQbQqxJinDMNXR8AqzgGoReADBZ7GQc52zMUkC6BKum7FC2JAAyelj8XIEx62RRbvsUWyAB5wZhQzoEVZUFIB7rsCVCyiot0mrYslW8DV66hjIAMkC2LEAUKYoShBPWyE4IGLEkaxmE+RQTEIbRsCQUnSf8CxVIk9GZLkhgwFJgI0QgeRNCgRISkoahJEICxtrIJyLF8LA6JgRj8ngZiXrxMh6BhbR48TsgU7TjPSfwKB9Fzhl89kyh6GLjovFwbBSfBK6YXgUneFJpzwl3qTrHYYoN8H7RyEgWeyXrxv8WwN4IG0Ux2-oruql7178WkZ4R6TiAce6dM7T1nuJee0lF5FxLj7JQ69N4qAgDvPeB81rHyxmfIYpM-7YGvsUdi98m6KCfmoV+tEP4tG7t-fuigIGSSgawLACdAHAMnmAueDDLDQOXrAhA8DXCIO3rvfeh9yoe3gOcawsBCCk3oQvOSN9CExAfs3Z+5D36dyoV-Z6P8yDyMYbXDiLCx69AnqAmenCFFLxXnAhBW9kEiLQUfNBrdd4GO4YXOuKjiE4Abm3IBlCmJ-ExEAA">list</a>
            for all the available error codes in Wowza Flowplayer.



            Example:

            **02-37**
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The device data you want returned in the response.

            Valid value is **devices**.

            Example:
            **devices**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: media_ids
          in: query
          required: false
          schema:
            type: string
          description: >-
            A comma separated list of IDs of the streams you want the returned
            data to reflect. 


            If **media_ids** aren't specified, then the pagination parameters,
            **limit** and **page**, are used instead to determine returned
            results. 


            Example: **abcd1234,wxyz3457**
        - name: include_recoverable
          in: query
          required: false
          schema:
            type: boolean
          description: |-
            Include recoverable errors in the response.
            Example: **true**
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Specify the number of results to return per page. The maximum number
            of results per page is 20. The default is 10.  The minimum value is
            1. 


            Example: **15**
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Returns a paginated view of results. Specify a positive integer to
            indicate which page of the results should be displayed.


            Pagination is determined according to the following logic:


            - If page=0, rows 1-10 are returned


            - If page=1, rows 11-20 are returned


            Example: **2**
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/analytics_qoe_errors_detail_message_error_code
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/errors/detail/resources/{error_code}:
    get:
      summary: Fetch a list of resource URLs impacted by a specific error code
      description: >-
        (Available from version 2.0) This operation returns a list of resource
        URLs impacted by a specific error code, along with their corresponding
        occurrence counts.
      operationId: analyticsQoeErrorsDetailResource
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/errors/detail/resources/:error_code/?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/errors/detail/resources/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: error_code
          in: path
          required: true
          description: >-
            The unique identifier that represents a specific playback error. See
            this <a
            href="https://try.flowplayer.com/?channel=stable#0=N4IgtglgJlA2CmIBcBWADAGhAZ3ggxgC7xTIgB0+22IW+A9rPQE5nMDmARgBQDMAHBnRCAbAEpaIQgAt4YREnABDYswhLYAWgAOG+ADsI7aYUmwlAT3oBXU4qW36k5vGwQAXvCWcEyQs2t4LBIIQm9fJH9ArEJ6Rk4lVkiAoJAAMwgEABVvGmTokFgIfQBrHM48qNTsaUT4ACFbWP0-FKwXJiUoRsJm1oKGfWxGBSqsB1iAJTx6Lv7UifppzqgAETxLZAAWNEwQRYAxenxrPLSNXHHHAAl4IxNkc9hLnHxmRlhkAG1MNABdLAZBB5L6gfRKeRkbQuABuEHgAHdJINiPo7CAQABfDBgiEKKT0EoGcgAKxodHoaIM6IRxSg9AR5AA+kyDgAZADyAHUAApsgCCAE0AKKTJlZDkAaWFADkALwAHRA8AsAClmEouQBFCAciCqrUAZRJUBlxukKCg7gAsrwtWB+BA2QBhVVoeAADX5uv1koAagBGHUu1XSTgAcXwPtVBwAqu4AJIBmX6gCc5BVqpJCZJ9HhAdpgq5MuwHudCZEKYAHvgE2BYCUyxWywbjabzZabXawKna-o0E7Xdp8LxrdHwxHU7x8OGq7IuX6LAn++Q-arrtd9F5w4bw6sufRBcwtiJDfh+at2Ch6uH+WhrvzmPxDbwPVlVQAmNLsNn0VOaGVCAALX4bRDQ-EQPTCLUSnwVN6Hqa4uWgcwIAgKt6GkfhhWYBEoGYElrQ5egPy1epJQRJUAG5JGkaAoAMeZsVxSFFFJckQBRakyA5TgSXgIgMzRNRXG4NImARbRzAseBmAzZh3mYbAxHINIWGFJR8GkbhuC+IkLAwAACBgGL+MQ5QAPkM4AFX0QzjMpbBCEM-ThQQOVDPpE55DRSgXBUeA3LkaluCVbBdH0JUxFs+zBichyGKCwyPK86wfMIPyvGIIL0tCnAIqimKHKGZywh8eBks8440upch2HgQgcupeolygPLZMUzQTNcQq7JclUgvIYgq0IZ1KVRZyPP0orusG4bRvG6lKu6oqyoQcglG0bQDDa1yECM2aEGi-RMQkLBcAIQgIEcsgUCQD9+CxHEQHBViKCoDiuLRMgAGIOpYLr6AY7BrKKqAIHC6SkEM9g1CgKiith6BNGIMApICwHYDSoZoYDNJmEMvHmCowyAHoACpDOFABHawNEM2koBkBysbAIZDPJ0nEc26GPzQbQqxJinDMNXR8AqzgGoReADBZ7GQc52zMUkC6BKum7FC2JAAyelj8XIEx62RRbvsUWyAB5wZhQzoEVZUFIB7rsCVCyiot0mrYslW8DV66hjIAMkC2LEAUKYoShBPWyE4IGLEkaxmE+RQTEIbRsCQUnSf8CxVIk9GZLkhgwFJgI0QgeRNCgRISkoahJEICxtrIJyLF8LA6JgRj8ngZiXrxMh6BhbR48TsgU7TjPSfwKB9Fzhl89kyh6GLjovFwbBSfBK6YXgUneFJpzwl3qTrHYYoN8H7RyEgWeyXrxv8WwN4IG0Ux2-oruql7178WkZ4R6TiAce6dM7T1nuJee0lF5FxLj7JQ69N4qAgDvPeB81rHyxmfIYpM-7YGvsUdi98m6KCfmoV+tEP4tG7t-fuigIGSSgawLACdAHAMnmAueDDLDQOXrAhA8DXCIO3rvfeh9yoe3gOcawsBCCk3oQvOSN9CExAfs3Z+5D36dyoV-Z6P8yDyMYbXDiLCx69AnqAmenCFFLxXnAhBW9kEiLQUfNBrdd4GO4YXOuKjiE4Abm3IBlCmJ-ExEAA">list</a>
            for all the available error codes in Wowza Flowplayer.



            Example:

            **02-37**
          schema:
            type: string
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The device data you want returned in the response.

            Valid value is **devices**.

            Example:
            **devices**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: media_ids
          in: query
          required: false
          schema:
            type: string
          description: >-
            A comma separated list of IDs of the streams you want the returned
            data to reflect. 


            If **media_ids** aren't specified, then the pagination parameters,
            **limit** and **page**, are used instead to determine returned
            results. 


            Example: **abcd1234,wxyz3457**
        - name: include_recoverable
          in: query
          required: false
          schema:
            type: boolean
          description: |-
            Include recoverable errors in the response.
            Example: **true**
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Specify the number of results to return per page. The maximum number
            of results per page is 20. The default is 10.  The minimum value is
            1. 


            Example: **15**
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Returns a paginated view of results. Specify a positive integer to
            indicate which page of the results should be displayed.


            Pagination is determined according to the following logic:


            - If page=0, rows 1-10 are returned


            - If page=1, rows 11-20 are returned


            Example: **2**
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/analytics_qoe_errors_detail_resources_error_code
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/rebuffer_count/account:
    get:
      summary: Fetch rebuffer count metrics for an account
      description: >-
        (Available from version 2.0) This operation returns the rebuffer count
        metrics for all the live streams and videos within the account related
        to the JSON web token used for API authentication.
      operationId: analyticsQoerebufferCountAccount
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/qoe/rebuffer_count/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/qoe/rebuffer_count/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The trend data you want returned in the response.

            Valid value is **trend**.

            Example:
            **trend**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_rebuffer_count_account'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/rebuffer_count/media/{id}:
    get:
      summary: Fetch rebuffer count metrics for specific live streams and videos
      description: >-
        (Available from version 2.0) This operation returns the rebuffer count
        metrics for specific live stream(s) and/or video(s).
      operationId: analyticsQoerebufferCountMedia
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/rebuffer_count/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/rebuffer_count/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the live stream or
            video. Send a comma-separated list of live stream and/or video
            **id**s to request error density data for specific live streams
            and/or videos.
          schema:
            type: string
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The trend data you want returned in the response.

            Valid value is **trend**.

            Example:
            **trend**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_rebuffer_count_media_id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/rebuffer_count/drilldown:
    get:
      summary: Fetch rebuffer count drill down metrics for your streams
      description: >-
        (Available from version 2.0) This operation returns the rebuffer count
        drill down metrics for all the live streams and videos within the
        account related to the JSON web token used for API authentication.
      operationId: analyticsQoerebufferCountDrilldown
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/qoe/rebuffer_count_drilldown?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z&include=devices';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/qoe/rebuffer_count/drilldown?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z&include=devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The device data you want returned in the response.

            Valid value is **devices**.

            Example:
            **devices**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: media_ids
          in: query
          required: false
          schema:
            type: string
          description: >-
            A comma separated list of IDs of the streams you want the returned
            data to reflect. 


            If **media_ids** aren't specified, then the pagination parameters,
            **limit** and **page**, are used instead to determine returned
            results. 


            Example: **abcd1234,wxyz3457**
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          description: |-
            Specify the order of the returned objects.

            Example: **plays**

            Enum: `"metric"` `"plays"`


            Default: `plays`
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Specify the number of results to return per page. The maximum number
            of results per page is 20. The default is 10.  The minimum value is
            1. 


            Example: **15**
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Returns a paginated view of results. Specify a positive integer to
            indicate which page of the results should be displayed.


            Pagination is determined according to the following logic:


            - If page=0, rows 1-10 are returned


            - If page=1, rows 11-20 are returned


            Example: **2**
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_rebuffer_count_drilldown'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/rebuffer_count/drilldown_trend/{ids}:
    get:
      summary: >-
        Fetch rebuffer count drill down trend metrics for specific live streams
        and videos
      description: >-
        (Available from version 2.0) This operation returns rebuffer count drill
        down trend metrics for specific live stream(s) and/or video(s).
      operationId: analyticsQoerebufferCountDrilldownTrend
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/qoe/rebuffer_count/drilldown_trend/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/qoe/rebuffer_count/drilldown_trend/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: ids
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the live stream or
            video. Send a comma-separated list of live stream and/or video
            **id**s to request trended rebuffer count drill down metrics for
            specific live streams and/or videos.



            **Note**: You can send up to 5 IDs in the request. If you send more
            than 5 IDs, only the first 5 IDs will be considered and the rest are
            ignored.
          schema:
            type: string
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/analytics_qoe_rebuffer_count_drilldown_trend
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/rebuffer_time/account:
    get:
      summary: Fetch rebuffer time metrics for an account
      description: >-
        (Available from version 2.0) This operation returns the rebuffer time
        for all the live streams and videos within the account related to the
        JSON web token used for API authentication.
      operationId: analyticsQoerebufferTimeAccount
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/rebuffer_time/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/rebuffer_time/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The trend data you want returned in the response.

            Valid value is **trend**.

            Example:
            **trend**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_rebuffer_time_account'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/rebuffer_time/media/{id}:
    get:
      summary: Fetch rebuffer time metrics for specific live streams and videos
      description: >-
        (Available from version 2.0) This operation returns the rebuffer time
        metrics for specific live stream(s) and/or video(s).
      operationId: analyticsQoerebufferTimeMedia
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/rebuffer_time/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/rebuffer_time/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the live stream or
            video. Send a comma-separated list of live stream and/or video
            **id**s to request error density data for specific live streams
            and/or videos.
          schema:
            type: string
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The trend data you want returned in the response.

            Valid value is **trend**.

            Example:
            **trend**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_rebuffer_time_media_id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/rebuffer_time/drilldown:
    get:
      summary: Fetch rebuffer time drill down metrics for your streams
      description: >-
        (Available from version 2.0) This operation returns the rebuffer time
        drill down metrics for all the live streams and videos within the
        account related to the JSON web token used for API authentication.
      operationId: analyticsQoerebufferTimeDrilldown
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/qoe/rebuffer_time/drilldown?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z&include=devices';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/qoe/rebuffer_time/drilldown?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z&include=devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The device data you want returned in the response.

            Valid value is **devices**.

            Example:
            **devices**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: media_ids
          in: query
          required: false
          schema:
            type: string
          description: >-
            A comma separated list of IDs of the streams you want the returned
            data to reflect.


            If **media_ids** aren't specified, then the pagination parameters,
            **limit** and **page**, are used instead to determine returned
            results. 


            Example: **abcd1234,wxyz3457**
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          description: |-
            Specify the order of the returned objects.

            Example: **plays**

            Enum: `"metric"` `"plays"`
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Specify the number of results to return per page. The maximum number
            of results per page is 20. The default is 10.  The minimum value is
            1. 


            Example: **15**
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Returns a paginated view of results. Specify a positive integer to
            indicate which page of the results should be displayed.


            Pagination is determined according to the following logic:


            - If page=0, rows 1-10 are returned


            - If page=1, rows 11-20 are returned


            Example: **2**
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_rebuffer_time_drilldown'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/rebuffer_time/drilldown_trend/{ids}:
    get:
      summary: >-
        Fetch rebuffer time drill down trend metrics for specific live streams
        and videos
      description: >-
        (Available from version 2.0) This operation returns rebuffer time drill
        down trend metrics for specific live stream(s) and/or video(s).
      operationId: analyticsQoerebufferTimeDrilldownTrend
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/qoe/rebuffer_time/drilldown_trend/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/qoe/rebuffer_time/drilldown_trend/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: ids
          in: path
          required: true
          description: >-
            The unique alphanumeric string that identifies the live stream or
            video. Send a comma-separated list of live stream and/or video
            **id**s to request trended rebuffer time drill down metrics for
            specific live streams and/or videos.



            **Note**: You can send up to 5 IDs in the request. If you send more
            than 5 IDs, only the first 5 IDs will be considered and the rest are
            ignored.
          schema:
            type: string
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/analytics_qoe_rebuffer_time_drilldown_trend
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/video_start_time/account:
    get:
      summary: Fetch video start time metrics for an account
      description: >-
        (Available from version 2.0) This operation returns the video start time
        metrics for all the live streams, real-time streams, and videos within
        the account related to the JSON web token used for API authentication.
      operationId: analyticsQoeVideoStartTimeAccount
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/video_start_time/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/video_start_time/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The trend data you want returned in the response.

            Valid value is **trend**.

            Example:
            **trend**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_video_start_time_account'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/video_start_time/media/{id}:
    get:
      summary: >-
        Fetch video start time metrics for specific live streams, real-time
        streams, and videos
      description: >-
        (Available from version 2.0) This operation returns the video start time
        metrics for specific live stream(s), real-time stream(s), and/or
        video(s).
      operationId: analyticsQoeVideoStartTimeMedia
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/2.0/analytics/qoe/video_start_time/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/2.0/analytics/qoe/video_start_time/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            A unique alphanumeric ID for a live stream, real-time stream, or
            video. Use a comma-separated list of these IDs to request trended
            video start time drilldown metrics.
          schema:
            type: string
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54.486Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The trend data you want returned in the response.

            Valid value is **trend**.

            Example:
            **trend**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.



            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_video_start_time_media_id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/video_start_time/drilldown:
    get:
      summary: Fetch video start time drill down metrics for your streams
      description: >-
        (Available from version 2.0) This operation returns the video start time
        drill down metrics for all the live streams, real-time streams, and
        videos within the account related to the JSON web token used for API
        authentication.
      operationId: analyticsQoevideostartTimeDrilldown
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/qoe/video_start_time/drilldown?from=2025-01-08T14:35Z&to=2025-02-08T14:35Z&include=devices';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/qoe/video_start_time/drilldown?from=2025-01-08T14:35:00.486Z&to=2025-02-08T14:35:00.486Z&include=devices';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: |-
            The device data you want returned in the response.

            Valid value is **devices**.

            Example:
            **devices**
          schema:
            type: string
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: media_ids
          in: query
          required: false
          schema:
            type: string
          description: >-
            A comma separated list of IDs of the streams you want the returned
            data to reflect.


            If **media_ids** aren't specified, then the pagination parameters,
            **limit** and **page**, are used instead to determine returned
            results. 


            Example: **abcd1234,wxyz3457**
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          description: |-
            Specify the order of the returned objects.

            Example: **plays**

            Enum: `"metric"` `"plays"`
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Specify the number of results to return per page. The maximum number
            of results per page is 20. The default is 10.  The minimum value is
            1. 


            Example: **15**
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Returns a paginated view of results. Specify a positive integer to
            indicate which page of the results should be displayed.


            Pagination is determined according to the following logic:


            - If page=0, rows 1-10 are returned


            - If page=1, rows 11-20 are returned


            Example: **2**
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_qoe_video_start_time_drilldown'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /analytics/qoe/video_start_time/drilldown_trend/{ids}:
    get:
      summary: >-
        Fetch video start time drill down trend metrics for specific live
        streams, real-time streams, and videos
      description: >-
        (Available from version 2.0) This operation returns video start time
        drill down trend metrics for specific live stream(s), real-time
        stream(s), and/or video(s).
      operationId: analyticsQoevideostartTimeDrilldownTrend
      tags:
        - quality_of_experience
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/analytics/qoe/video_start_time/drilldown_trend/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z';
        - lang: JavaScript
          source: >-
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/analytics/qoe/video_start_time/drilldown_trend/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: ids
          in: path
          required: true
          description: >-
            A unique alphanumeric ID for a live stream, real-time stream, or
            video. Use a comma-separated list of these IDs to request trended
            video start time drilldown metrics.


            **Note**: You can send up to 5 IDs in the request. If you send more
            than 5 IDs, only the first 5 IDs will be considered and the rest are
            ignored.
          schema:
            type: string
        - name: from
          in: query
          required: true
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-DD-MMT HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC.
            The range queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: true
          description: >-
            The end of the range of time you want to view. Specify **YYYY-DD-MMT
            HH:MM:SSZ**  where **HH** is a 24-hour clock in UTC. The range
            queried is rounded to the nearest  second.


            Example:

            **2024-03-14T10:31:54Z**
          schema:
            type: string
            format: date-time
        - name: devices
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the devices you want the returned data to reflect. If you
            don't specify a device, the returned data includes all the playback
            devices.


            Example: **Desktop**


            enum: `"Desktop"` `"Anonymized"` `"Mobile"` `"Tablet"` `"Watch"`
            `"Phone"` `"AugmentedReality"` `"VirtualReality"` `"EReader"`
            `"SetTopBox"` `"TV"` `"GameConsole"` `"HandheldGameConsole"`
            `"HomeAppliance"` `"Voice"` `"Car"` `"Cloud"` `"Robot"`
            `"RobotMobile"` `"RobotImitator"` `"Hacker"` `"Unknown"`
            `"Unclassified"` `"SmartDisplay"`
        - name: time_zone
          in: query
          required: false
          schema:
            type: string
          description: >-
            Specify the time zone you want the returned data to reflect. 


            <details> <summary>Click to expand for the full list of valid
            values</summary>


              | Locations |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/analytics_qoe_video_start_time_drilldown_trend
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /usage/transcoders:
    get:
      summary: Fetch usage for all transcoders
      description: >-
        This operation shows the amount of usage (egress) for all transcoders in
        the account. The default time frame is *from* the last billing date *to*
        the end of the current day.
      operationId: usageTranscodersIndex
      tags:
        - usage_transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/usage/transcoders"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/usage/transcoders';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-MM-DD HH:00:00** where **HH** is a 24-hour clock in UTC. The
            range doesn't include minutes and seconds and rounds minutes up to
            the hour. The maximum difference between **from** and **to** is 90
            days. If you set the **from** query parameter without setting the
            **to** query parameter, the data returned will reflect 90 days
            starting at the **from** date, or data up to to the current day,
            whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: last billing date
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-MM-DD
            HH:00:00** where **HH** is a 24-hour clock in UTC. The range doesn't
            include minutes and seconds and rounds minutes up to the hour. The
            maximum difference between **from** and **to** is 90 days. If you
            set the **to** query parameter without setting the **from** query
            parameter, the data returned will be from the past 90 days or from
            your last invoice date, whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: end of the current day
          schema:
            type: string
            format: date-time
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage_transcoders'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /usage/transcoders/{id}:
    get:
      summary: Fetch usage for a single transcoder
      description: >-
        (Available from version 1.4) This operation shows the amount of usage
        (egress) for a specific transcoder. The default time frame is *from* the
        last billing date *to* the end of the current day.
      operationId: showUsageTranscoder
      tags:
        - usage_transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/usage/transcoders/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/usage/transcoders/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the transcoder.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-MM-DD HH:00:00** where **HH** is a 24-hour clock in UTC. The
            range doesn't include minutes and seconds and rounds minutes up to
            the hour. The maximum difference between **from** and **to** is 90
            days. If you set the **from** query parameter without setting the
            **to** query parameter, the data returned will reflect 90 days
            starting at the **from** date, or data up to to the current day,
            whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: last billing date
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-MM-DD
            HH:00:00** where **HH** is a 24-hour clock in UTC. The range doesn't
            include minutes and seconds and rounds minutes up to the hour. The
            maximum difference between **from** and **to** is 90 days. If you
            set the **to** query parameter without setting the **from** query
            parameter, the data returned will be from the past 90 days or from
            your last invoice date, whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: end of the current day
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid value is: **trend**.


            Example:

            **trend**
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage_transcoder'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /usage/transcoders/summary:
    get:
      summary: Fetch transcoder usage summary
      description: >-
        (Available from version 1.4) This operation shows a summary of the
        amount of usage (egress) for all transcoders in the account. The default
        time frame is *from* the last billing date *to* the end of the current
        day.
      operationId: summaryUsageTranscoder
      tags:
        - usage_transcoders
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/usage/transcoders/summary"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/usage/transcoders/summary';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-MM-DD HH:00:00** where **HH** is a 24-hour clock in UTC. The
            range doesn't include minutes and seconds and rounds minutes up to
            the hour. The maximum difference between **from** and **to** is 90
            days. If you set the **from** query parameter without setting the
            **to** query parameter, the data returned will reflect 90 days
            starting at the **from** date, or data up to to the current day,
            whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: last billing date
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-MM-DD
            HH:00:00** where **HH** is a 24-hour clock in UTC. The range doesn't
            include minutes and seconds and rounds minutes up to the hour. The
            maximum difference between **from** and **to** is 90 days. If you
            set the **to** query parameter without setting the **from** query
            parameter, the data returned will be from the past 90 days or from
            your last invoice date, whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: end of the current day
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage_transcoder_summary'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /usage/stream_targets:
    get:
      summary: Fetch usage for all stream targets
      description: >-
        (Available from version 1.4) This operation returns detailed CDN usage
        data for all stream targets in the account. Defaults: from = last
        billing date, to = end of current day.
      operationId: usageStreamTargetsIndex
      tags:
        - usage
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/usage/stream_targets"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/usage/stream_targets';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-MM-DD HH:00:00** where **HH** is a 24-hour clock in UTC. The
            range doesn't include minutes and seconds and rounds minutes up to
            the hour. The maximum difference between **from** and **to** is 90
            days. If you set the **from** query parameter without setting the
            **to** query parameter, the data returned will reflect 90 days
            starting at the **from** date, or data up to to the current day,
            whichever is shorter. T


            You can also specify **last_bill_date**.


            **Default**: last billing date
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-MM-DD
            HH:00:00** where **HH** is a 24-hour clock in UTC. The range doesn't
            include minutes and seconds and rounds minutes up to the hour. The
            maximum difference between **from** and **to** is 90 days. If you
            set the **to** query parameter without setting the **from** query
            parameter, the data returned will be from the past 90 days or from
            your last invoice date, whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: end of the current day
          schema:
            type: string
            format: date-time
        - $ref: '#/components/parameters/next_page_key'
        - $ref: '#/components/parameters/per_page_2.0'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage_stream_targets'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /usage/stream_targets/{id}:
    get:
      summary: Fetch usage for a single stream target
      description: >-
        (Available from version 1.4) This operation returns CDN usage details
        for a specific stream target. Defaults: from = last billing date, to =
        end of current day.
      operationId: showUsageStreamTarget
      tags:
        - usage
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/usage/stream_targets/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/usage/stream_targets/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-MM-DD HH:00:00** where **HH** is a 24-hour clock in UTC. The
            range doesn't include minutes and seconds and rounds minutes up to
            the hour. The maximum difference between **from** and **to** is 90
            days. If you set the **from** query parameter without setting the
            **to** query parameter, the data returned will reflect 90 days
            starting at the **from** date, or data up to to the current day,
            whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: last billing date
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-MM-DD
            HH:00:00** where **HH** is a 24-hour clock in UTC. The range doesn't
            include minutes and seconds and rounds minutes up to the hour. The
            maximum difference between **from** and **to** is 90 days. If you
            set the **to** query parameter without setting the **from** query
            parameter, the data returned will be from the past 90 days or from
            your last invoice date, whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: end of the current day
          schema:
            type: string
            format: date-time
        - name: include
          in: query
          required: false
          description: >-
            Specify the data you want returned in the response. You can send a
            comma-separated list of values.


            Valid value is: **trend**.


            Example:

            **trend**
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage_stream_target'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /usage/stream_targets/summary:
    get:
      summary: Fetch stream target usage summary
      description: >-
        (Available from version 1.4) This operation returns a summary of CDN
        usage for all stream targets in the account. Defaults: from = last
        billing date, to = end of current day.
      operationId: summmaryUsageStreamTarget
      tags:
        - usage
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/usage/stream_targets/summary"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/usage/stream_targets/summary';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-MM-DD HH:00:00** where **HH** is a 24-hour clock in UTC. The
            range doesn't include minutes and seconds and rounds minutes up to
            the hour. The maximum difference between **from** and **to** is 90
            days. If you set the **from** query parameter without setting the
            **to** query parameter, the data returned will reflect 90 days
            starting at the **from** date, or data up to to the current day,
            whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: last billing date
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-MM-DD
            HH:00:00** where **HH** is a 24-hour clock in UTC. The range doesn't
            include minutes and seconds and rounds minutes up to the hour. The
            maximum difference between **from** and **to** is 90 days. If you
            set the **to** query parameter without setting the **from** query
            parameter, the data returned will be from the past 90 days or from
            your last invoice date, whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: end of the current day
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage_stream_target_summary'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /usage/real_time_streams:
    get:
      summary: Fetch usage for all real-time streams
      description: >-
        (Available from version 1.9) This operation returns detailed CDN usage
        data for all real-time streams in the account. Defaults: from = last
        billing date, to = end of current day.
      operationId: usageRealTimeStreamsIndex
      tags:
        - usage_real_time_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \

              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/usage/real_time_streams"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/usage/real_time_streams';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-MM-DD HH:00:00** where **HH** is a 24-hour clock in UTC. The
            range doesn't include minutes and seconds and rounds minutes up to
            the hour. The maximum difference between **from** and **to** is 90
            days. If you set the **from** query parameter without setting the
            **to** query parameter, the data returned will reflect 90 days
            starting at the **from** date, or data up to to the current day,
            whichever is shorter. T


            You can also specify **last_bill_date**.


            **Default**: last billing date
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-MM-DD
            HH:00:00** where **HH** is a 24-hour clock in UTC. The range doesn't
            include minutes and seconds and rounds minutes up to the hour. The
            maximum difference between **from** and **to** is 90 days. If you
            set the **to** query parameter without setting the **from** query
            parameter, the data returned will be from the past 90 days or from
            your last invoice date, whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: end of the current day
          schema:
            type: string
            format: date-time
        - $ref: '#/components/parameters/next_page_key'
        - $ref: '#/components/parameters/per_page_2.0'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage_real_time_streams'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /usage/real_time_streams/{id}:
    get:
      summary: Fetch usage for a single real-time stream
      description: >-
        (Available from version 1.9) This operation returns CDN usage details
        for a specific stream target. Defaults: from = last billing date, to =
        end of current day.
      operationId: showUsageRealTimeStream
      tags:
        - usage_real_time_streams
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \

              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/usage/real_time_streams/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/usage/real_time_streams/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the stream target.
          schema:
            type: string
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-MM-DD HH:00:00** where **HH** is a 24-hour clock in UTC. The
            range doesn't include minutes and seconds and rounds minutes up to
            the hour. The maximum difference between **from** and **to** is 90
            days. If you set the **from** query parameter without setting the
            **to** query parameter, the data returned will reflect 90 days
            starting at the **from** date, or data up to to the current day,
            whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: last billing date
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-MM-DD
            HH:00:00** where **HH** is a 24-hour clock in UTC. The range doesn't
            include minutes and seconds and rounds minutes up to the hour. The
            maximum difference between **from** and **to** is 90 days. If you
            set the **to** query parameter without setting the **from** query
            parameter, the data returned will be from the past 90 days or from
            your last invoice date, whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: end of the current day
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage_real_time_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /usage/real_time_streams/summary:
    get:
      summary: Fetch real-time stream usage summary
      description: >-
        (Available from version 1.11) This operation returns a summary of CDN
        usage for all real-time streams in the account.
      operationId: summmaryUsageRealtimeStream
      tags:
        - usage_real_time_streams
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/usage/real_time_streams/summary"
        - lang: JavaScript
          source: |-
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/usage/real_time_streams/summary';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            The start of the range of time you want to view. Specify
            **YYYY-MM-DD HH:00:00** where **HH** is a 24-hour clock in UTC. The
            range doesn't include minutes and seconds and rounds minutes up to
            the hour. The maximum difference between **from** and **to** is 90
            days. If you set the **from** query parameter without setting the
            **to** query parameter, the data returned will reflect 90 days
            starting at the **from** date, or data up to to the current day,
            whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: last billing date
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: >-
            The end of the range of time you want to view. Specify **YYYY-MM-DD
            HH:00:00** where **HH** is a 24-hour clock in UTC. The range doesn't
            include minutes and seconds and rounds minutes up to the hour. The
            maximum difference between **from** and **to** is 90 days. If you
            set the **to** query parameter without setting the **from** query
            parameter, the data returned will be from the past 90 days or from
            your last invoice date, whichever is shorter.


            You can also specify **last_bill_date**.


            **Default**: end of the current day
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage_real_time_stream_summary'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /real_time:
    post:
      summary: Create a real-time stream
      description: This operation creates a real-time stream.
      operationId: createRealTimeStream
      tags:
        - real_time
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/real_time" \
              -d $'{
              "real_time_stream": {
                "name": "My Real-Time Stream"
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/real_time';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "real_time_stream": {
                "name": "My Real-Time Stream"
              }
            }));
            req.end();
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/real_time_stream_create'
        description: >-
          Provide the details of the real-time stream to create in the body of
          the request.
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - real_time_stream
                properties:
                  real_time_stream:
                    $ref: '#/components/schemas/real_time_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch all real-time streams
      description: >-
        This operation shows limited details for all of your real-time streams.
        For detailed information, fetch a single real-time stream.
      operationId: listRealTimeStreams
      tags:
        - real_time
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/real_time"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/real_time';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/real_time_streams'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
  /real_time/{id}:
    get:
      summary: Fetch a real-time stream
      description: This operation shows the details of a specific real-time stream.
      operationId: showRealTimeStream
      tags:
        - real_time
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/real_time/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/real_time/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the real-time stream.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - real_time_stream
                properties:
                  real_time_stream:
                    $ref: '#/components/schemas/real_time_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    patch:
      summary: Update a real-time stream
      description: This operation updates a real-time stream.
      operationId: updateRealTimeStream
      tags:
        - real_time
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/real_time/2adffc17" \
              -d $'{
              "real_time_stream": {
                "name": "MyRealTimeStream"
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/real_time/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname',
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "real_time_stream": {
                "name": "MyRealTimeStream"
              }
            }));
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the real-time stream.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/real_time_stream_update'
        description: >-
          Provide the details of the real-time stream to update in the body of
          the request.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - real_time_stream
                properties:
                  real_time_stream:
                    $ref: '#/components/schemas/real_time_stream'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      summary: Delete a real-time stream
      description: This operation deletes a real-time stream.
      operationId: deleteRealTimeStream
      tags:
        - real_time
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/real_time/2adffc17"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/real_time/2adffc17';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the real-time stream.
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /real_time/{id}/state:
    get:
      summary: Fetch the state of a real-time stream
      description: This operation shows the current state of a real-time stream.
      operationId: showRealTimeStreamState
      tags:
        - real_time
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/real_time/2adffc17/state"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/real_time/2adffc17/state';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the real-time stream.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - real_time
                properties:
                  real_time:
                    type: object
                    title: real_time
                    properties:
                      state:
                        type: string
                        description: The state of the real-time stream.
                        example: stopped
                        enum:
                          - started
                          - stopped
                          - disabled
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /real_time/{id}/stop:
    put:
      summary: Stop a real-time stream
      description: This operation stops a real-time stream.
      operationId: stopRealTimeStream
      tags:
        - real_time
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/real_time/2adffc17/stop"
        - lang: JavaScript
          source: |-
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/real_time/2adffc17/stop';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.end();
      parameters:
        - name: id
          in: path
          required: true
          description: The unique alphanumeric string that identifies the real-time stream.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - real_time_stream
                properties:
                  real_time_stream:
                    type: object
                    title: real_time_stream
                    properties:
                      state:
                        type: string
                        description: The state of the real-time stream.
                        example: stopped
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
        '423':
          description: Locked
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error423'
  /videos:
    post:
      tags:
        - videos
      summary: Create a video
      description: >-
        This operation creates a video object in Wowza Video. You can upload a
        video from your local storage (DIRECT) or from an external storage
        provider (FETCH).
      operationId: createVideo
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/videos" \
              -d $'{
              "name": "My New Video",
              "description": "A new video for my business.",
              "unpublish": true,
              "unpublished_at": "2025-01-01T12:33:22Z",
              "published": true,
              "published_at": "2024-01-01T12:33:22Z",
              "tags": [
                "foo",
                "bar"
              ],
              "category_id": "<The default category>",
              "no_ads": true,
              "ad_keywords": "special_ads",
              "input": {
                "method": "REMOTE",
                "remote_urls": "https://example.com/video.mp4",
                "duration_in_ms": 0
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/videos';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "name": "My New Video",
              "description": "A new video for my business.",
              "unpublish": true,
              "unpublished_at": "2025-01-01T12:33:22Z",
              "published": true,
              "published_at": "2024-01-01T12:33:22Z",
              "tags": [
                "foo",
                "bar"
              ]
              "category_id": "<The default category>",
              "no_ads": true,
              "ad_keywords": "special_ads",
              "input": {
                "method": "REMOTE",
                "remote_urls": "https://example.com/video.mp4",
                "duration_in_ms": 0
              }
            }));
            req.end();
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVideoRequestModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVideoResponseModel'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      tags:
        - videos
      summary: Fetch all videos
      description: This operation shows details for all videos available in Wowza Video.
      operationId: listVideos
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/videos"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/videos';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: page
          in: query
          description: >-
            Returns a paginated view of results from the HTTP request. Specify a
            positive integer to indicate which page of the results should be
            displayed. The default is **1**.
          schema:
            type: integer
            format: int32
            default: 1
        - name: per_page
          in: query
          description: >-
            For use with the page parameter. Indicates how many records should
            be included in a page of results. A valid value is any positive
            integer. The default and maximum value is **1000**.
          schema:
            type: integer
            format: int32
            default: 20
        - name: created_at
          in: query
          description: >
            Filter the response based on an asset's timespan. The filter can be
            specified in following formats:


            | Spec | Description |

            |-----|-------|

            | `YYYY-MM-DD'T'HH:mm:ss`  | Returns all assets with created_at
            after the specified date |
          schema:
            type: string
          example: 2024-01-01T00:00:00+0000,2024-02-01T00:00:00+0000
        - name: updated_at
          in: query
          description: >
            Filter the response based on an asset's timespan. The filter can be
            specified in following formats:


            | Spec | Description |

            |-----|-------|

            | `YYYY-MM-DD'T'HH:mm:ss`  | Returns all assets with updated_at
            after the specified date |
          schema:
            type: string
          example: 2024-01-01T00:00:00+0000,2024-02-01T00:00:00+0000
        - name: published_at
          in: query
          description: >
            Filter the response based on an asset's timespan. The filter can be
            specified in following formats:


            | Spec | Description |

            |-----|-------|

            | `YYYY-MM-DD'T'HH:mm:ss`  | Returns all assets with published_at
            after the specified date |
          schema:
            type: string
          example: 2024-01-01T00:00:00+0000,2024-02-01T00:00:00+0000
        - name: state
          in: query
          description: >
            The current state of the video. The state reflects the current
            status of the video files for the video asset. Possible states
            listed below:



            | State | Description |

            |-----------|-------|

            | UPLOADING  | The source file is currently being uploaded or
            waiting to be downloaded by our API. |

            | WAITING_FOR_ENCODER | The source file was successfully downloaded
            by the platform and is in queue to be encoded. |

            | PROCESSING  | Source file for the asset is encoding. The current
            encoding progress can be found on `encoding_progress` property. |

            | FINISHED | The encoding is done and the encoded files can be
            fetched. In this state it's possible to embed the video. |

            | ERROR  | If the platform, for some reason, could not download the
            source file or failed during the encoding process. `error_messsage`
            property can give more information about why it errored.  |

            | DELETED  | The video files have been deleted. Usually the video
            asset have been deleted when this state is reached and because of
            that it's very uncommon to see assets with this state. |
          example: FINISHED
          schema:
            type: string
        - name: query
          in: query
          description: >
            Search multiple text fields in a search that is case insensitive and
            does not require full matches. URL encode the value of the `query`
            to ensure that it can be processed. There are free URL encoders
            online.


            It searches `name`, `description`, `tags` searches all your custom
            fields for matching terms.

            You can search specific fields by specifying them after a colon
            (`:`); if you have multiple search terms you can use `pipe` (`|`) to
            separate the search terms.


            Some examples:


            | Query | Description |

            | ----- | ----------- |

            | `query=foo` | Searches all fields for `foo`. |
          schema:
            type: string
          example: foo:name,custom_fields
        - name: sort_column
          in: query
          schema:
            type: string
            enum:
              - created_at
              - name
              - published_at
              - duration
        - name: sort_direction
          in: query
          schema:
            type: string
            enum:
              - desc
              - asc
        - name: origin_id
          in: query
          description: >-
            The unique alphanumeric string that identifies the live stream or
            the real-time stream from which the video originated.


            Returns all the videos associated with the same ID.
          schema:
            type: string
            example: edfg8k34
        - name: categories
          in: query
          description: >-
            Filters videos by specific categories. Provide one or more category
            ID(s) to retrieve only the videos that belong to those categories.

            To enter multiple category IDs, enter the IDs as a comma-separated
            list. You can specify up to four category IDs.


            **Note:** To get the ID of a category, call the GET /categories
            endpoint and choose the category ID you need.
          schema:
            type: string
            example: cb65a918-ad7d-406a-80d8-09c9c8d0dbb
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
  /videos/{id}:
    get:
      tags:
        - videos
      summary: Fetch a video
      description: This operation shows details for a single, specified video.
      operationId: getSingleVideo
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/videos/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/videos/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          description: Unique identifier for the video.
          required: true
          schema:
            type: string
            example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoResponseModel'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    patch:
      tags:
        - videos
      summary: Update a video's metadata
      description: >-
        This operation updates a video's metadata. To replace the video file,
        use the `PUT /video/ID`.
      operationId: patchVideo
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/videos/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2" \
              -d $'{
              "name": "My video",
              "description": "A new video for my business.",
              "unpublish": true,
              "unpublished_at": "2025-01-01T12:33:22Z",
              "published": true,
              "published_at": "2024-01-01T12:33:22Z",
              "tags": [
                "foo",
                "bar"
              ],
              "category_id": "<The default category>",
              "no_ads": true,
              "ad_keywords": "special_ads"
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/videos/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "name": "My video",
              "description": "A new video for my business.",
              "unpublish": true,
              "unpublished_at": "2025-01-01T12:33:22Z",
              "published": true,
              "published_at": "2024-01-01T12:33:22Z",
              "tags": [
                "foo",
                "bar"
              ],
              "category_id": "<The account's default category>",
              "no_ads": true,
              "ad_keywords": "special_ads"
            }));
            req.end();
      parameters:
        - name: id
          in: path
          description: Unique identifier for the video.
          required: true
          schema:
            type: string
            example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchVideoRequestModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoResponseModel'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    put:
      tags:
        - videos
      summary: Re-upload a video
      description: This operation initiates a re-upload of a video.
      operationId: reuploadVideo
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PUT" \
              "${WV_HOST}/api/beta/videos/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2" \
              -d $'{
              "input": {
                "method": "REMOTE",
                "remote_urls": "https://example.com/video.mp4",
                "duration_in_ms": 0
              }
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/videos/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'PUT',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "input": {
                "method": "REMOTE",
                "remote_urls": "https://example.com/video.mp4",
                "duration_in_ms": 0
              }
            }));
            req.end();
      parameters:
        - name: id
          in: path
          description: Unique identifier for the video.
          required: true
          schema:
            type: string
            example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReuploadVideoRequestModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVideoResponseModel'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      tags:
        - videos
      summary: Delete a video
      description: This operation deletes a video and all its related files.
      operationId: deleteVideo
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/videos/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/videos/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          description: Unique identifier for the video
          required: true
          schema:
            type: string
            example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /categories:
    post:
      tags:
        - categories
      summary: Create a category
      description: >-
        This operation creates a category you can assign to a video for
        organization.
      operationId: createCategory
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/categories" \
              -d $'{
              "name": "My first category",
              "description": "This is a category description",
              "parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"  
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/categories';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "name": "My first category",
              "description": "This is a category description",
              "parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"  
            }));
            req.end();
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CategoryRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      tags:
        - categories
      summary: Fetch all categories
      description: >-
        This operation shows details for all categories available in Wowza
        Video.
      operationId: listCategories
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/categories"
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/categories';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: page
          in: query
          description: >-
            Returns a paginated view of results from the HTTP request. Specify a
            positive integer to indicate which page of the results should be
            displayed. The default is **1**.
          schema:
            type: integer
            format: int32
            default: 1
        - name: per_page
          in: query
          description: >-
            For use with the page parameter. Indicates how many records should
            be included in a page of results. A valid value is any positive
            integer. The default and maximum value is **1000**.
          schema:
            type: integer
            format: int32
            default: 1000
        - name: query
          in: query
          schema:
            type: string
            description: >-
              Searches text fields case insensitive and partial. Full matches
              aren't required.


              For categories, `name` and `description` are the only searchable
              fields.


              Limit to a specific field with a `colon` (`:`).


              If you have multiple search terms you can use `pipe` (`|`) to
              separate the search terms.


              Examples:


              | Query | Description |

              | ----- | ----------- |

              | `query=foo` | Searches name & description field for `foo`. |

              | `query=foo:description` | Searches description field for `foo`.
              |

              | `query=foo\|bar` | Searches name for `foo` and  `bar`. A
              category must match both to be included.|
        - name: sort_column
          in: query
          schema:
            type: string
            enum:
              - name
            default: name
        - name: sort_direction
          in: query
          schema:
            type: string
            default: DESC
        - name: only_top_level
          in: query
          schema:
            type: boolean
            description: >-
              Only categories without parent categories will be returned if set
              to `true`.
            default: false
        - name: parent_id
          in: query
          schema:
            type: string
            description: >-
              Limit search to categories with a specific parent category. When
              specified, only child categories with the specified parent will be
              returned.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryListModel'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
  /categories/{id}:
    get:
      tags:
        - categories
      summary: Fetch a category
      description: This operation shows details for a single, specified category.
      operationId: getCategory
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/categories/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/categories/51cd5c07-1583-4f5e-bd81-f1aa11510ea9';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          description: Unique identifier for the category.
          required: true
          schema:
            type: string
            example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
    patch:
      tags:
        - categories
      summary: Update a category
      description: |-
        This operation updates a category. 

        Only the fields that are sent in the request body will be updated.
      operationId: updateCategory
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "PATCH" \
              "${WV_HOST}/api/beta/categories/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2" \
              -d $'{
              "name": "My first Category",
              "description": "This is a category description",
              "parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"
            }'
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/categories/51cd5c07-1583-4f5e-bd81-f1aa11510ea9';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'PATCH',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });

            req.write(JSON.stringify({
              "name": "My first category",
              "description": "This is a category description",
              "parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"  
            }));

            req.end();
      parameters:
        - name: id
          in: path
          description: Unique identifier for the category.
          required: true
          schema:
            type: string
            example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CategoryRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    delete:
      tags:
        - categories
      summary: Delete a category
      description: This operation deletes a category.
      operationId: deleteCategory
      x-codeSamples:
        - lang: Shell
          source: |
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/categories/2aa3343e-2fb5-42c3-8671-b52c24b7c3e2"
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/categories/51cd5c07-1583-4f5e-bd81-f1aa11510ea9';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          description: Unique identifier for the category.
          required: true
          schema:
            type: string
            example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /playback_tokens/keys:
    post:
      summary: Create a playback token key
      description: >-
        This operation creates a playback token key that includes a key id and
        key value. You use one or both of these parameters to create a playback
        token for advanced token authentication. 


        Before using the **ADVANCED_TOKEN** option as your token authentication
        for a video, you must do **one** of the following: 

          - Generate a playback token key that has a key id using this endpoint in the Wowza Video API, then customize and generate a token via the Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token.  
          - Generate a playback token key that has a key id and key value using this endpoint in the Wowza Video 2.0 API, then customize and generate a standard common access token (CAT) through the means you usually use to create tokens to add to your site. You'll need the key id and key to create and sign the token. 
            The key value is only returned in this endpoint so keep it in a place that you can access it later when you create your playback token. 
      operationId: CreateKey
      tags:
        - advanced_token_authentication
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/playback_tokens/keys" \
              -d $'{
              "name": "key for token"
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/playback_tokens/keys';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "name": "key for token"
            }));
            req.end();
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePlaybackTokenKeyRequestWrapper'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePlaybackTokenKeyResponseWrapper'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
    get:
      summary: Fetch playback token keys
      description: >-
        This operation shows details for playback token keys you've created that
        are available in Wowza Video for your account. The details include a key
        id which you use to create a playback token for advanced token
        authentication. 
      operationId: listPlaybackTokenKeys
      tags:
        - advanced_token_authentication
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "GET" \
              "${WV_HOST}/api/beta/playback_tokens/keys" \
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/playback_tokens/keys';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            https.get(options, function(res) {
              var body = '';
              res.on('data', function(data){
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: query
          in: query
          schema:
            type: string
          description: >-
            `Name` is the only searchable field.


            Limit to a specific field with a `colon` (`:`).


            If you have multiple search terms you can use `pipe` (`|`) to
            separate the search terms.


            Examples:

             | Query | Description |
             | ----- | ----------- |
             | `query=foo` | Searches name field for `foo`. |
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/per_page'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPlaybackTokenKeyResponseWrapper'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
  /playback_tokens/keys/{id}:
    delete:
      summary: Delete a playback token key
      description: This operation deletes a playback token key.
      operationId: deletePublicTokenKey
      tags:
        - advanced_token_authentication
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "DELETE" \
              "${WV_HOST}/api/beta/playback_tokens/keys/51cd5c07-1583-4f5e-bd81-f1aa11510ea9" \
        - lang: JavaScript
          source: >
            // Using Node.js

            const https = require('https');

            const crypto = require('crypto');

            var hostname = 'api.video.wowza.com'

            var path =
            '/api/beta/playback_tokens/keys/51cd5c07-1583-4f5e-bd81-f1aa11510ea9';

            //For security, never reveal API token in client-side code

            var wvJWT = 'Bearer [your JWT]';


            const options = {
              hostname: hostname,
              path: path,
              method: 'DELETE',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };

            https.get(options, function(res) {
              // no data being returned, just: 204 NO CONTENT
              console.log(res.statusCode);
            }).on('error', function(e) {
              console.log(e.message);
            });
      parameters:
        - name: id
          in: path
          description: Unique identifier, or key id, for the playback token keys.
          required: true
          schema:
            type: string
            example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9
      responses:
        '204':
          description: No content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /playback_tokens:
    post:
      summary: Create a playback token
      description: >-
        This operation creates a playback token for use with advanced token
        authentication.


        You'll use the PATCH /videos/{id} endpoint to select **ADVANCED_TOKEN**
        authentication for your video after you have the  playback token. Then,
        you'll add the token into your player site along with the JS-embed for
        the video.


        Before using the **ADVANCED_TOKEN** option as your token authentication
        for a video, you must do the following: 

          - Generate a playback token key that has a key id using the POST /playback_tokens/key in the Wowza Video API, then customize and generate a token via this endpoint in the Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token.  
      operationId: CreatePlaybackToken
      tags:
        - advanced_token_authentication
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/playback_tokens" \
              -d $'{
              "exp": 1679816499,
              "key_id": "51cd5c07-1583-4f5e-bd81-f1aa11510ea9",
              "nbf": "1759183200",
              "iat": "1759183200",
              "iss": "my-issuer",
              "sub": "subscriber1234",
              "aud": "my-audience",
              "cti": "unique-token-id",
              "catnip": [
                  {
                      "tag": 52,
                      "value": [24, { "0": 188, "1": 4, "2": 23 }]
                  },
                  {
                      "tag": 54,
                      "value": [48, { "0": 42, "1": 2, "2": 33, "3": 73, "4": 135, "5": 128}]
                  }
              ],
              "catu": {
                   "1":[
                      0,
                      "cdn.example.com"
                  ],
                   "3":[
                      3,
                      "video-id"
                  ]
              },
              "catgeoiso3166": [
                   "US",
                   "CA-ON"
              ],
              "catv": 1
            }'
        - lang: JavaScript
          source: |
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/playback_tokens';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
              "exp": "1679816499",
              "key_id": "51cd5c07-1583-4f5e-bd81-f1aa11510ea9",
              "nbf": "1759183200",
              "iat": "1759183200",
              "iss": "my-issuer",
              "sub": "subscriber1234",
              "aud": "my-audience",
              "cti": "unique-token-id",
              "catnip": [
                  {
                      "tag": 52,
                      "value": [24, { "0": 188, "1": 4, "2": 23}]
                  },
                  {
                      "tag": 54,
                      "value": [48, { "0": 42, "1": 2, "2": 33, "3": 73, "4": 135, "5": 128 }]
                  }
              ],
              "catu": {
                   "1":[
                      0,
                      "cdn.example.com"
                  ],
                   "3":[
                      3,
                      "video-id"
                  ]
              },
              "catgeoiso3166": [
                   "US",
                   "CA-ON"
              ],
              "catv": 1
            }));
            req.end();
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateTokenRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateTokenResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
  /clipping:
    post:
      tags:
        - clipping
      summary: Create a clip
      description: >-
        This operation creates (or replaces) a video object in Wowza Video by
        clipping a video or live stream or, clipping and stitching together
        videos or live streams.


        **Create a clip**


        To create a clip off of an existing video or live stream, send the `id`
        of the video or live stream you want to clip along with the
        `asset_type`, `mode`, `start`, and `stop` parameters.


        **Create clips and stitch the clips**


        To create multiple clips and stitch the clips together as one clip, send
        the `id` of the videos or live streams you want to clip along with the
        `asset_type`, `mode`, `start`, and `stop` parameters.


        **Create a clip and replace the original video**


        To create a clip and replace the original video with the clip, send the
        `replace_video_id` parameter where `replace_video_id` is the video id of
        the video to be replaced, along with the `asset_type`, `mode`, `start`,
        and `stop` parameters.


        **Note**: The replace option works only with videos and not live
        streams. The `replace_video_id` is specifically a video ID and not a
        live stream ID.


        **Caution!** Once you replace the original video with the clip, you will
        no longer be able to retrieve the original video.
      operationId: CreateClipStitch
      x-codeSamples:
        - lang: Shell
          source: |-
            // Using cURL
            curl -H "Authorization: Bearer ${WV_JWT}" \
              
              -H "Content-Type: application/json" \
              -X "POST" \
              "${WV_HOST}/api/beta/clipping" \
              -d $'{
              "clips": {
                "id": "test",
                "asset_type": "VOD",
                "start_time": "00:01:20:00",
                "stop_time": "00:05:25:00"
                },
              "name": "My video",
              "description": "A new video for my business.",
              "unpublish": true,
              "unpublished_at": "2025-01-01T12:33:22Z",
              "published": true,
              "published_at": "2024-05-01T12:33:22Z",
              "tags": [
                "foo",
                "bar"
              ],
              "category_id": "<The default category>",
              "no_ads": true,
              "ad_keywords": "special_ads",
            }'
        - lang: JavaScript
          source: |-
            // Using Node.js
            const https = require('https');
            const crypto = require('crypto');
            var hostname = 'api.video.wowza.com'
            var path = '/api/beta/clipping';
            //For security, never reveal API token in client-side code
            var wvJWT = 'Bearer [your JWT]';

            const options = {
              hostname: hostname,
              path: path,
              method: 'POST',
              headers: {
                'Authorization': wvJWT,
                'Content-Type': 'application/json'
              }
            };
            const req = https.request(options, function(res) {
              var body = '';
              res.on('data', function(data) {
                body += data;
              });
              res.on('end', function() {
                console.log(JSON.parse(body));
              });
            }).on('error', function(e) {
              console.log(e.message);
            });
            req.write(JSON.stringify({
                "clips": {
                  "id": "test",
                  "asset_type": "VOD",
                  "start_time": "00:01:20:00",
                  "stop_time": "00:05:25:00",
                  },
              "name": "My New Video",
              "description": "A new video for my business.",
              "unpublish": true,
              "unpublished_at": "2025-01-01T12:33:22Z",
              "published": true,
              "published_at": "2024-01-01T12:33:22Z",
              "tags": [
                "foo",
                "bar"
              ]
              "category_id": "<The default category>",
              "no_ads": true,
              "ad_keywords": "special_ads",
            }));
            req.end();
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClipStitchRequestModel'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateClipStitchResponseModel'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '410':
          description: Gone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error410'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error422'
x-tagGroups:
  - name: Resource Management
    tags:
      - live_streams
      - transcoders
      - stream_sources
      - stream_targets
      - schedules
      - real_time
      - videos
      - categories
      - advanced_token_authentication
      - clipping
  - name: Analytics
    tags:
      - analytics_viewers
      - analytics_ingest
      - analytics_engagement
      - analytics_popularity
      - quality_of_experience
  - name: Usage
    tags:
      - usage_account
      - usage_transcoders
      - usage
      - storage
      - usage_vod_streams
      - usage_real_time_streams
servers:
  - url: https://api.video.wowza.com/api/beta
components:
  securitySchemes:
    WV_JWT:
      type: http
      scheme: bearer
      description: >-
        Your Wowza-generated access token, also called a JSON web token (JWT).
        Send it as a bearer token in the Authentication header of your requests.
        See
        [Authentication](https://www.wowza.com/docs/how-to-use-the-wowza-video-rest-api#authentication).
  parameters:
    filter:
      name: filter
      in: query
      description: >-
        Restricts the data that gets returned by filtering on one or more values
        associated with a field. Construct a filter using a two-part expression
        that specifies the field on which to filter and the logic to use to
        filter. Filters use a zero-based index.


        For valid filter operators and filter fields, see [How to get filtered
        query results with the Wowza Video REST
        API](https://www.wowza.com/docs/how-to-get-filtered-query-results-with-the-wowza-video-rest-api).


        Example:

        **filter[0][field]=state&filter[0][eq]=stopped**
      schema:
        type: string
    page:
      name: page
      in: query
      description: >-
        Returns a paginated view of results from the HTTP request. Specify a
        positive integer to indicate which page of the results should be
        displayed. The default is **1**. 

         For more information and examples, see [Get paginated query results with the Wowza Video REST API](https://www.wowza.com/docs/how-to-get-paginated-query-results-with-the-wowza-video-rest-api).
      schema:
        type: integer
    per_page:
      name: per_page
      in: query
      description: >-
        For use with the *page* parameter. Indicates how many records should be
        included in a page of results. A valid value is any positive integer.
        The default and maximum value is **1000**.
      schema:
        type: integer
    assignable_stream_target:
      name: assignable
      in: query
      description: >-
        Returns stream targets that are assignable to an output.  If **true**,
        all assignable stream targets are included in the response.  If the
        parameter isn't used, all assignable and unassignable stream targets are
        included in the response.



        A **primary_stream_target** is a single stream target that
        automatically  gets created for all output renditions (the ABR ladder)
        created when you create a live stream  through a live stream flow.
        **Primary_stream_targets** cannot be deleted or reassigned so they will
        not be listed when using the assignable parameter.


        Example:

        **api.video.wowza.com/api/v2.0/stream_targets?assignable=true**
      schema:
        type: string
    next_page_key:
      name: next_page_key
      in: query
      description: >-
        (Available from version 1.5) Returns a paginated view of results from
        the HTTP request. Specify a page key ID to indicate which page of the
        results should be displayed.
      schema:
        type: string
    per_page_2.0:
      name: per_page
      in: query
      description: >-
        For use with the *next_page_key* parameter. Indicates how many records
        should be included in a page of results. A valid value is any positive
        integer. The default and maximum value is **1000**.
      schema:
        type: integer
  schemas:
    index_live_stream:
      type: object
      title: live_streams
      description: ''
      properties:
        created_at:
          type: string
          description: The date and time that the live stream was created.
          example: ''
          format: date-time
        id:
          type: string
          description: The unique alphanumeric string that identifies the live stream.
          example: ''
        name:
          type: string
          description: A descriptive name for the live stream. Maximum 200 characters.
          example: ''
        state:
          type: string
          description: The state of the live stream.
          example: started
          enum:
            - starting
            - stopping
            - started
            - stopped
            - resetting
        updated_at:
          type: string
          description: The date and time that the live stream was updated.
          example: ''
          format: date-time
    live_streams:
      type: object
      description: ''
      required:
        - live_streams
      properties:
        live_streams:
          type: array
          items:
            $ref: '#/components/schemas/index_live_stream'
      example:
        live_streams:
          - id: wdjfqvsv
            name: My PAYG Transcoded WSE Live Stream
            state: stopped
            created_at: '2020-01-29T17:16:21.849Z'
            updated_at: '2020-01-31T16:06:47.849Z'
          - id: KyxWKtHQ
            name: My 24x7 Passthrough Live Stream
            state: started
            created_at: '2020-01-29T17:16:21.849Z'
            updated_at: '2020-01-31T02:26:05.849Z'
          - id: Ly40ZDSg
            name: My PAYG Transcoded Teradek Cube Live Stream
            state: started
            created_at: '2020-01-29T17:16:21.849Z'
            updated_at: '2020-01-30T18:13:18.849Z'
    Error401:
      type: object
      description: ''
      required:
        - meta
      properties:
        meta:
          type: object
          title: meta
          description: ''
          properties:
            status:
              type: integer
              description: ''
              example: ''
              format: int32
            code:
              type: string
              description: ''
              example: ''
            title:
              type: string
              description: ''
              example: ''
            message:
              type: string
              description: ''
              example: ''
            description:
              type: string
              description: ''
              example: ''
            links:
              type: array
              description: ''
              example: ''
              items: {}
      example:
        Example Response 1:
          meta:
            status: 401
            code: ERR-401-NoApiKey
            title: No API Key Error
            message: No API key sent in header.
            description: ''
            links: []
        Example Response 2:
          meta:
            status: 401
            code: ERR-401-NoAccessKey
            title: No Access Key Error
            message: No access key sent in header.
            description: ''
            links: []
        Example Response 3:
          meta:
            status: 401
            code: ERR-401-InvalidApiKey
            title: Invalid Api Key Error
            message: Invalid API key.
            description: ''
            links: []
        Example Response 4:
          meta:
            status: 401
            code: ERR-401-InvalidAccessKey
            title: Invalid Access Key Error
            message: Invalid access key.
            description: ''
            links: []
        Example Response 5:
          meta:
            status: 401
            code: ERR-401-BadAccountStatus
            title: Bad Account Status Error
            message: Your account's status doesn't allow this action.
            description: ''
            links: []
        Example Response 6:
          meta:
            status: 401
            code: ERR-401-FeatureNotEnabled
            title: Feature Not Enabled Error
            message: This feature isn't enabled.
            description: ''
            links: []
        Example Response 7:
          meta:
            status: 401
            code: ERR-401-TrialExceeded
            title: Bad Billing Status Error
            message: >-
              Your billing status needs attention. You can't start or add live
              streams until your billing status is updated.
            description: ''
            links: []
        Example Response 8:
          meta:
            status: 401
            code: ERR-401-ExpiredToken
            title: JWT is expired
            message: Token has exired.
            description: ''
            links: []
        Example Response 9:
          meta:
            status: 401
            code: ERR-401-InvalidToken
            title: JWT is invalid
            message: Token is invalid.
            description: ''
            links: []
    broadcast_location:
      type: string
      description: >-
        The location of your stream. Choose a location as close as possible to
        your video source.
      example: eu_germany
      enum:
        - asia_pacific_australia
        - asia_pacific_india
        - asia_pacific_japan
        - asia_pacific_singapore
        - asia_pacific_s_korea
        - asia_pacific_taiwan
        - eu_belgium
        - eu_germany
        - eu_ireland
        - south_america_brazil
        - us_central_iowa
        - us_east_s_carolina
        - us_east_virginia
        - us_west_california
        - us_west_oregon
    hosted_page_request_object_create:
      type: object
      description: Configuration of the hosted page.
      properties:
        enabled:
          type: boolean
          description: >-
            A web page hosted by Wowza Video that includes a player for the live
            stream. The default, **true**, creates a hosted page. Specify
            **false** to not create a hosted web page.


            **Example:** <code>"enabled": true</code>
          example: ''
        description:
          type: string
          description: >-
            A description that appears on the hosted page below the player.
            Can't include custom HTML, JavaScript, or other tags.


            **Example:** <code>"description": "My Hosted Page
            Description"</code>
          example: ''
        logo_image:
          type: string
          description: >-
            A Base64-encoded string representation of a GIF, JPEG, or PNG logo
            file that that appears in the upper-left corner of the hosted page.
            Logo file must be 2.5 MB or smaller.


            **Example:** <code>"logo_image": "[Base64-encoded string
            representation of GIF, JPEG, or PNG file]"</code>
          example: '[Base64-encoded string representation of GIF, JPEG, or PNG file]'
        sharing_icons:
          type: boolean
          description: >-
            Icons that let viewers share the stream on Facebook, Google+,
            Twitter, and by email. The default, **true**, includes sharing icons
            on the hosted page. Specify **false** to omit sharing icons.


            **Example:** <code>"sharing_icons": false</code>
          example: ''
        title:
          type: string
          description: >-
            A title for the page that appears above the player. Can't include
            custom HTML, JavaScript, or other tags.


            **Example:** <code>"title": "My Hosted Page"</code>
          example: ''
    live_stream_create_input:
      type: object
      description: ''
      required:
        - live_stream
      properties:
        live_stream:
          type: object
          title: live_stream
          description: ''
          required:
            - name
            - broadcast_location
            - encoder
          properties:
            broadcast_location:
              $ref: '#/components/schemas/broadcast_location'
            encoder:
              type: string
              description: >-
                The video source for the live stream. Choose the type of camera
                or encoder you're using to connect to the Wowza Video
                transcoder. If your specific device isn't listed, choose
                **ipcamera**, **other_rtmp**, or **other_rtsp**.
              example: other_webrtc
              enum:
                - wowza_clearcaster
                - wowza_gocoder
                - wowza_streaming_engine
                - media_ds
                - axis
                - epiphan
                - file
                - hauppauge
                - jvc
                - live_u
                - matrox
                - newtek_tricaster
                - osprey
                - sony
                - telestream_wirecast
                - teradek_cube
                - vmix
                - x_split
                - ipcamera
                - other_rtmp
                - other_rtsp
                - other_webrtc
                - other_udp
                - other_srt
            name:
              type: string
              description: A descriptive name for the live stream. Maximum 200 characters.
              example: My Live Stream
            aspect_ratio_height:
              type: integer
              description: >-
                The height, in pixels, of the video source. Should correspond to
                a widescreen (16:9) or standard (4:3) aspect ratio and be
                divisible by 8. Combined with **aspect_ratio_width**, makes up
                the input resolution.


                Default: **720**.
              example: 1080
              format: int32
            aspect_ratio_width:
              type: integer
              description: >-
                The width, in pixels, of the video source. Should correspond to
                a widescreen (16:9) or standard (4:3) aspect ratio and be
                divisible by 8. Combined with **aspect_ratio_height**, makes up
                the input resolution.


                Default: **1280**.
              example: 1920
              format: int32
            billing_mode:
              type: string
              description: >-
                The billing mode for the stream. 


                Default: **pay_as_you_go**.



                **pay_as_you_go** — Billed as a single event. A single event is
                use-based and you incur charges for the time spent streaming.


                **twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel
                is unlimited stream time for one channel. This billing mode
                doesn't incur overages, since it's unlimited.
              example: pay_as_you_go
              enum:
                - pay_as_you_go
                - twentyfour_seven
            closed_caption_type:
              type: string
              description: >-
                The type of closed caption data being passed from the source.
                The default, **none**, indicates that no data is being provided.
                **cea** indicates that a CEA closed captioning data stream is
                being provided. **on_text** indicates that an onTextData closed
                captioning data stream is being provided. **both** indicates
                that both CEA and onTextData closed captioning data streams are
                being provided.


                **Example:** <code>"closed_caption_type": "none"</code>
              example: none
              enum:
                - none
                - cea
                - on_text
                - both
            delivery_method:
              type: string
              description: >-
                The type of connection between the video source and the
                transcoder. The default, **push**, instructs the source to push
                the stream to the transcoder. **pull** instructs the transcoder
                to pull the video from the source. **cdn** uses a stream source
                to deliver the stream to the transcoder.


                Default: **push**


                **Example:** <code>"delivery_method": "pull"</code>
              example: push
              enum:
                - pull
                - cdn
                - push
            delivery_protocols:
              type: array
              description: >-
                An array of direct delivery protocols enabled for this live
                stream. By default, **rtmp**, **rtsp**, **webrtc**, and **wowz**
                are enabled.


                **Example:** See response body sample
              items:
                type: string
            description:
              type: string
              description: An optional description of the live stream.
              example: ''
            disable_authentication:
              type: boolean
              description: >-
                Authentication is required by default for RTMP and RTSP push
                connections from a video source to Wowza Video. Specify **true**
                to disable authentication with the video source.


                **Example:** <code>"disable_authentication": false</code>
              example: false
            hosted_page:
              $ref: '#/components/schemas/hosted_page_request_object_create'
            low_latency:
              type: boolean
              description: >-
                For streams whose *target_delivery_protocol* is **hls-https**.
                If **true**, turns off incoming and sort packet buffers and
                delivers smaller video packets to the player, which can reduce
                latency as long as networks can handle the increased overhead.
                The default is **false**.


                 **Example:** <code>"low_latency": false</code>
              example: false
            password:
              type: string
              description: >-
                A password for authenticating an RTMP or RTSP push connection.
                Can contain only uppercase and lowercase letters; numbers; and
                the period (.), underscore (_), and hyphen (-) characters. No
                other special characters can be used.


                **Example:** <code>"password": 68332313</code>
              example: '68332313'
            player_id:
              type: string
              description: >-
                (Available from version 2.0) The unique alphanumeric string that
                identifies the player configuration to use for this stream. 


                When you pass a player configuration ID, Wowza Video uses that
                player configuration to customize and style the player. If you
                don't pass a value, the default player configuration for the
                account is used.


                Create and edit player configurations in the user interface. The
                ID is on the **General** tab for the player configuration.


                **Default**: Default player configuration


                **Example**: 2205b4e8-b160-43c2-868d-d88698a4e850
              example: ''
            logo_image:
              type: string
              description: >-
                A Base64-encoded string representation of a GIF, JPEG, or PNG
                logo  file that appears partially transparent in a corner of the
                player throughout playback. Logo file must be 2.5 MB or smaller.


                **Example:** <code>"logo_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>   
              example: ''
            logo_position:
              type: string
              description: >-
                The corner of the player in which you want the player logo to
                appear. The default is **top-left**.


                **Example:** <code>"logo_position": "top-right"</code>
              example: ''
              enum:
                - top-left
                - top-right
                - bottom-left
                - bottom-right
            video_poster_image:
              type: string
              description: >-
                The path to a GIF, JPEG, or PNG poster image that appears in the
                player before the stream begins. Poster image files must be 2.5
                MB or smaller.


                **Example:** <code>"video_poster_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>
              example: ''
            width:
              type: integer
              description: >-
                The width, in pixels, of a fixed-size player. The default is
                **640**.


                **Example:** <code>"width": 640</code>
              example: ''
              format: int32
            recording:
              type: boolean
              description: >-
                If **true**, creates a recording of the live stream. The
                recording starts when the live stream starts and stops
                automatically when the live stream stops.


                Recordings created from a live stream capture up to eight hours
                of content. If a live stream runs for longer than eight hours,
                the most recent eight hours are recorded. To record more than
                eight hours of a single broadcast, stop the live stream and
                start it again to create multiple recordings.


                Default: **false**


                > **Note**: If **save_asset** is **true**, that field overrides
                a true **recording** value and the asset is saved in Asset
                Management.


                **Example:** <code>"recording": true</code>
              example: true
            reference_id:
              type: string
              description: >-
                A unique, alphanumeric ID returned in transcoder webhook
                payloads. Setting a *reference_id* is useful if you have an ID
                in your system or application you want to associate with
                transcoder events that trigger webhooks. Maximum 70 characters.
                Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|


                You can't use brackets or quotation marks.


                See <a
                href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza
                Video Webhook Event Reference Documentation</a> to learn about
                webhooks.


                Available from version 1.7.


                **Example:** <code>"reference_id": "mySystemID_01"</code>
              example: mySystemID_01
            save_asset:
              type: boolean
              description: >-
                If **true**, saves an MP4 recording and a VOD asset in Asset
                Management. The default is **false**. You can't set
                **save_asset** for a live stream created from re-streaming an
                asset in Asset Management.

                > **Note**: If this value is true, **recording** and/or
                **vod_stream** are set to false. You need a Wowza Video
                subscription to access Asset Management.


                Available from version 1.8.


                **Example:** <code>"save_asset": true</code>
              example: true
            security:
              type: object
              description: >-
                Configuration of stream security. These settings only apply to
                Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn
                Live, or custom targets.
              properties:
                force_ssl_playback:
                  type: boolean
                  description: >-
                    If **true**, requires users to play the stream over HTTPS.
                    If **false**, the default, users can play the stream over
                    HTTPS or HTTP.


                    **Example:** <code>"force_ssl_playback": true</code>
                  example: ''
                geoblock_enabled:
                  type: boolean
                  description: >-
                    If **true**, controls access to the stream from specific
                    locations and, optionally, IP addresses. The default is
                    **false**.


                    **Example:** <code>"geoblock_enabled": true</code>
                  example: ''
                geoblock_by_location:
                  type: string
                  description: >-
                    Specifies whether to **allow** or **deny** access to the
                    stream from specific locations. The default is **disabled**.


                    **Example:** <code>"geoblock_location": "allow"</code>
                  example: ''
                  enum:
                    - allow
                    - deny
                    - disabled
                geoblock_country_codes:
                  type: string
                  description: >-
                    Required when *geoblock_by_location* is **allow** or
                    **deny**. The locations affected by the geo-blocking. Enter
                    a comma-separated list of capitalized two-letter ISO 3166-1
                    country codes. For a list, see [ISO
                    3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on
                    Wikipedia.


                    **Example:** <code>"geoblock_country_codes": "CA, DE"</code>
                  example: ''
                geoblock_ip_override:
                  type: string
                  description: >-
                    Specifies whether specific IP addresses can override the
                    locations that are allowed or restricted. **allow** permits
                    access from IP addresses within a location that's been
                    blocked, while **deny** restricts access from IP addresses
                    within locations that are allowed. The default is
                    **disabled**.


                    **Example:** <code>"geoblock_ip_override": "allow"</code>
                  example: ''
                  enum:
                    - allow
                    - deny
                    - disabled
                geoblock_ip_addresses:
                  type: string
                  description: >-
                    Required when *geoblock_ip_override* is **allow** or
                    **deny**. Addresses that can access or restrict the stream
                    even if they're within a specified geo-blocked location.
                    Enter a comma-separated list of up to about 40 IPv4 and IPv6
                    IP addresses that always allow or deny streaming based on
                    the *geoblock_ip_override* value. 


                    <blockquote><strong>Troubleshooting:</strong> The limit of
                    40 IP addresses is approximate because  all the security
                    information (SSL playback, geoblocking countries and IP
                    addresses, referer header,  and token auth) count toward an
                    overall metadata limit.</blockquote>


                    **Example:** <code>"geoblock_ip_addresses": "77.12.34.567,
                    78.23.45.678"</code>
                  example: ''
                token_auth_enabled:
                  type: boolean
                  description: >-
                    If **true**, token authentication protects the stream by
                    ensuring that it's delivered only to authorized viewers and
                    can't be shared by unauthorized links or player hijacking
                    attacks. The default is **false**.


                    **Example:** <code>"token_auth_enabled": true</code>
                  example: ''
                token_auth_shared_secret:
                  type: string
                  description: >-
                    The shared secret of the token authentication. Must contain
                    only hexadecimal characters and be an even number of total
                    characters not exceeding 32.


                    **Example:** <code>"token_auth_shared_secret":
                    "12345678ABCDEF"</code>
                  example: ''
                token_auth_playlist_only:
                  type: boolean
                  description: >-
                    If **true**, Wowza Video uses token authentication to
                    protect the master playlist only and leaves individual media
                    playlists and media segments unprotected. This feature
                    enables playback compatibility with media players that don’t
                    support the *withCredentials* property. It may also be
                    useful when addressing token auth compatibility issues with
                    specific browsers. The default is **false**.


                    **Note**: If you've enabled MPEG-DASH on your stream target,
                    `token_auth_playlist_only` applies to both the
                    `playlist.m3u8` for HLS and `manifest.mpd` for MPEG-DASH.


                    **Example:** <code>"token_auth_playlist_only": true</code>
                  example: ''
            source_url:
              type: string
              description: >-
                For the *delivery_method* **pull** or *encoder* **file**.


                For **pull**, enter the URL of an IP camera or video encoder
                using an RTMP and RTSP pull connection to Wowza Video. Consult
                the camera or encoder documentation for the URL syntax.


                For **file**, enter the source file URL, including the protocol
                (http, https, gs, s3).



                **Example:** <code>"source_url":
                "xyz.streamlock.net/vod/mp4:Movie.mov"</code>
              example: xyz.streamlock.net/vod/mp4:Movie.mov
            target_delivery_protocol:
              type: string
              description: >-
                The type of stream being delivered from Wowza Video. The default
                and only valid value is **hls-https**. 


                **Example:** <code>"target_delivery_protocol":
                "hls-https"</code>
              example: hls-https
              enum:
                - hls-https
            transcoder_type:
              type: string
              description: >-
                The type of transcoder, either **transcoded** for streams that
                are transcoded into adaptive bitrate renditions or
                **passthrough** for streams that aren't processed by the
                transcoder. 



                > **Note**: **passthrough** isn't supported in the
                **asia_pacific_singapore** region.



                Default: **transcoded**.
              example: transcoded
              enum:
                - transcoded
                - passthrough
            use_stream_source:
              type: boolean
              description: >-
                If **true**, uses a stream source to deliver the stream to Wowza
                Video. The default, **false**, pushes directly to Wowza Video.


                **Example:** <code>"use_stream_source": false</code>
              example: false
            username:
              type: string
              description: >-
                A user name for authenticating an RTMP or RTSP push connection.
                Can contain only uppercase and lowercase letters; numbers; and
                the period (.), underscore (_), and hyphen (-) characters. No
                other special characters can be used.


                **Example:** <code>"username": "client2"</code>
              example: client2
            vod_stream:
              type: boolean
              description: >-
                If **true**, creates a VOD stream after the live stream ends.
                The default is **false**. VOD streams require a Fastly stream
                target with HLS as a delivery protocol.

                > **Note**: If **save_asset** is **true**, that field overrides
                a true **vod_stream** value and the asset is saved in Asset
                Management.


                **Example:** <code>"vod_stream": true</code>
              example: true
            watermark:
              type: boolean
              description: >-
                Embeds an image into the transcoded stream for copyright
                protection. Specify **true** to embed a watermark image.



                **Example:** <code>"watermark": true</code>
              example: ''
            watermark_height:
              type: integer
              description: >-
                The height, in pixels, of the watermark image. If blank, Wowza
                Video uses the original image height.


                **Example:** <code>"watermark_height": 80</code>
              example: ''
              format: int32
            watermark_image:
              type: string
              description: >-
                A Base64-encoded string representation of a GIF, JPEG, or PNG
                image that is embedded in all bitrate renditions of the stream.
                Watermark image files must be 2.5 MB or smaller.


                **Example:** <code>"watermark_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>
              example: ''
            watermark_opacity:
              type: integer
              description: >-
                The opacity, or percentage of transparency, of the watermark.
                **0** is fully transparent; **100** is fully opaque.


                **Example:** <code>"watermark_opacity": 75</code>
              example: ''
              enum:
                - 0
                - 1
                - 2
                - 3
                - 4
                - 5
                - 6
                - 7
                - 8
                - 9
                - 10
                - 11
                - 12
                - 13
                - 14
                - 15
                - 16
                - 17
                - 18
                - 19
                - 20
                - 21
                - 22
                - 23
                - 24
                - 25
                - 26
                - 27
                - 28
                - 29
                - 30
                - 31
                - 32
                - 33
                - 34
                - 35
                - 36
                - 37
                - 38
                - 39
                - 40
                - 41
                - 42
                - 43
                - 44
                - 45
                - 46
                - 47
                - 48
                - 49
                - 50
                - 51
                - 52
                - 53
                - 54
                - 55
                - 56
                - 57
                - 58
                - 59
                - 60
                - 61
                - 62
                - 63
                - 64
                - 65
                - 66
                - 67
                - 68
                - 69
                - 70
                - 71
                - 72
                - 73
                - 74
                - 75
                - 76
                - 77
                - 78
                - 79
                - 80
                - 81
                - 82
                - 83
                - 84
                - 85
                - 86
                - 87
                - 88
                - 89
                - 90
                - 91
                - 92
                - 93
                - 94
                - 95
                - 96
                - 97
                - 98
                - 99
                - 100
              format: int32
            watermark_position:
              type: string
              description: >-
                The corner of the video frame in which you want the watermark to
                appear. The default is **top-left**.


                **Example:** <code>"watermark_position": "top-left"</code>
              example: ''
              enum:
                - top-left
                - top-right
                - bottom-left
                - bottom-right
            watermark_width:
              type: integer
              description: >-
                The width, in pixels, of the watermark image. If blank, Wowza
                Video uses the original image width.


                **Example:** <code>"watermark_width": 100</code>
              example: ''
              format: int32
            countdown:
              type: boolean
              description: 'Enables or disables a countdown timer. '
              example: ''
            countdown_at:
              type: string
              description: >-
                The month, day, year, and time of day that the countdown timer
                should stop displaying to the viewer. Specify **YYYY-MM-DD 
                HH:MM:SS**.



                For example, if you set the **countdown_at** for
                **2024-12-15T17:00:00:000Z** and the **countdown_timezone** as 
                **America/New_York**, the viewer would see their current time
                minus the time remaining until the date and time you set. So, if
                there's 5 hours  to go until 1700 NYC time for the viewer, the
                viewer sees **5:00:00** on the player indicating there are 5
                hours left and the timer counts down from there. The countdown
                starts as soon as the streamer configures it.


                Required when **countdown** is **true**.


                **Example:** <code>"countdown_at": "2024-02-01T00:00:00.000Z"
              example: '2024-02-01T00:00:00.000Z'
              format: date-time
            countdown_timezone:
              type: string
              example: America/New_York
              description: >-
                The time zone the countdown timer runs in.


                Required when **countdown** is **true**.


                <details> <summary>Click to expand for the full list of valid
                values</summary>

                  | Locations |  Wowza Video time_zone value |
                  |---|---|
                  | International Date Line West  | Etc/GMT+12                     |
                  | Midway Island                 | Pacific/Midway                 |
                  | American Samoa                | Pacific/Pago_Pago              |
                  | Hawaii                        | Pacific/Honolulu               |
                  | Alaska                        | America/Juneau                 |
                  | Pacific Time (US & Canada)    | America/Los_Angeles            |
                  | Tijuana                       | America/Tijuana                |
                  | Mountain Time (US & Canada)   | America/Denver                 |
                  | Arizona                       | America/Phoenix                |
                  | Chihuahua                     | America/Chihuahua              |
                  | Mazatlan                      | America/Mazatlan               |
                  | Central Time (US & Canada)    | America/Chicago                |
                  | Saskatchewan                  | America/Regina                 |
                  | Guadalajara                   | America/Mexico_City            |
                  | Mexico City                   | America/Mexico_City            |
                  | Monterrey                     | America/Monterrey              |
                  | Central America               | America/Guatemala              |
                  | Eastern Time (US & Canada)    | America/New_York               |
                  | Indiana (East)                | America/Indiana/Indianapolis   |
                  | Bogota                        | America/Bogota                 |
                  | Lima                          | America/Lima                   |
                  | Quito                         | America/Lima                   |
                  | Atlantic Time (Canada)        | America/Halifax                |
                  | Caracas                       | America/Caracas                |
                  | La Paz                        | America/La_Paz                 |
                  | Santiago                      | America/Santiago               |
                  | Newfoundland                  | America/St_Johns               |
                  | Brasilia                      | America/Sao_Paulo              |
                  | Buenos Aires                  | America/Argentina/Buenos_Aires |
                  | Montevideo                    | America/Montevideo             |
                  | Georgetown                    | America/Guyana                 |
                  | Puerto Rico                   | America/Puerto_Rico            |
                  | Greenland                     | America/Godthab                |
                  | Mid-Atlantic                  | Atlantic/South_Georgia         |
                  | Azores                        | Atlantic/Azores                |
                  | Cape Verde Is.                | Atlantic/Cape_Verde            |
                  | Dublin                        | Europe/Dublin                  |
                  | Edinburgh                     | Europe/London                  |
                  | Lisbon                        | Europe/Lisbon                  |
                  | London                        | Europe/London                  |
                  | Casablanca                    | Africa/Casablanca              |
                  | Monrovia                      | Africa/Monrovia                |
                  | UTC                           | Etc/UTC                        |
                  | Belgrade                      | Europe/Belgrade                |
                  | Bratislava                    | Europe/Bratislava              |
                  | Budapest                      | Europe/Budapest                |
                  | Ljubljana                     | Europe/Ljubljana               |
                  | Prague                        | Europe/Prague                  |
                  | Sarajevo                      | Europe/Sarajevo                |
                  | Skopje                        | Europe/Skopje                  |
                  | Warsaw                        | Europe/Warsaw                  |
                  | Zagreb                        | Europe/Zagreb                  |
                  | Brussels                      | Europe/Brussels                |
                  | Copenhagen                    | Europe/Copenhagen              |
                  | Madrid                        | Europe/Madrid                  |
                  | Paris                         | Europe/Paris                   |
                  | Amsterdam                     | Europe/Amsterdam               |
                  | Berlin                        | Europe/Berlin                  |
                  | Bern                          | Europe/Zurich                  |
                  | Zurich                        | Europe/Zurich                  |
                  | Rome                          | Europe/Rome                    |
                  | Stockholm                     | Europe/Stockholm               |
                  | Vienna                        | Europe/Vienna                  |
                  | West Central Africa           | Africa/Algiers                 |
                  | Bucharest                     | Europe/Bucharest               |
                  | Cairo                         | Africa/Cairo                   |
                  | Helsinki                      | Europe/Helsinki                |
                  | Kyiv                          | Europe/Kiev                    |
                  | Riga                          | Europe/Riga                    |
                  | Sofia                         | Europe/Sofia                   |
                  | Tallinn                       | Europe/Tallinn                 |
                  | Vilnius                       | Europe/Vilnius                 |
                  | Athens                        | Europe/Athens                  |
                  | Istanbul                      | Europe/Istanbul                |
                  | Minsk                         | Europe/Minsk                   |
                  | Jerusalem                     | Asia/Jerusalem                 |
                  | Harare                        | Africa/Harare                  |
                  | Pretoria                      | Africa/Johannesburg            |
                  | Kaliningrad                   | Europe/Kaliningrad             |
                  | Moscow                        | Europe/Moscow                  |
                  | St. Petersburg                | Europe/Moscow                  |
                  | Volgograd                     | Europe/Volgograd               |
                  | Samara                        | Europe/Samara                  |
                  | Kuwait                        | Asia/Kuwait                    |
                  | Riyadh                        | Asia/Riyadh                    |
                  | Nairobi                       | Africa/Nairobi                 |
                  | Baghdad                       | Asia/Baghdad                   |
                  | Tehran                        | Asia/Tehran                    |
                  | Abu Dhabi                     | Asia/Muscat                    |
                  | Muscat                        | Asia/Muscat                    |
                  | Baku                          | Asia/Baku                      |
                  | Tbilisi                       | Asia/Tbilisi                   |
                  | Yerevan                       | Asia/Yerevan                   |
                  | Kabul                         | Asia/Kabul                     |
                  | Ekaterinburg                  | Asia/Yekaterinburg             |
                  | Islamabad                     | Asia/Karachi                   |
                  | Karachi                       | Asia/Karachi                   |
                  | Tashkent                      | Asia/Tashkent                  |
                  | Chennai                       | Asia/Kolkata                   |
                  | Kolkata                       | Asia/Kolkata                   |
                  | Mumbai                        | Asia/Kolkata                   |
                  | New Delhi                     | Asia/Kolkata                   |
                  | Kathmandu                     | Asia/Kathmandu                 |
                  | Astana                        | Asia/Dhaka                     |
                  | Dhaka                         | Asia/Dhaka                     |
                  | Sri Jayawardenepura           | Asia/Colombo                   |
                  | Almaty                        | Asia/Almaty                    |
                  | Novosibirsk                   | Asia/Novosibirsk               |
                  | Rangoon                       | Asia/Rangoon                   |
                  | Bangkok                       | Asia/Bangkok                   |
                  | Hanoi                         | Asia/Bangkok                   |
                  | Jakarta                       | Asia/Jakarta                   |
                  | Krasnoyarsk                   | Asia/Krasnoyarsk               |
                  | Beijing                       | Asia/Shanghai                  |
                  | Chongqing                     | Asia/Chongqing                 |
                  | Hong Kong                     | Asia/Hong_Kong                 |
                  | Urumqi                        | Asia/Urumqi                    |
                  | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
                  | Singapore                     | Asia/Singapore                 |
                  | Taipei                        | Asia/Taipei                    |
                  | Perth                         | Australia/Perth                |
                  | Irkutsk                       | Asia/Irkutsk                   |
                  | Ulaanbaatar                   | Asia/Ulaanbaatar               |
                  | Seoul                         | Asia/Seoul                     |
                  | Osaka                         | Asia/Tokyo                     |
                  | Sapporo                       | Asia/Tokyo                     |
                  | Tokyo                         | Asia/Tokyo                     |
                  | Yakutsk                       | Asia/Yakutsk                   |
                  | Darwin                        | Australia/Darwin               |
                  | Adelaide                      | Australia/Adelaide             |
                  | Canberra                      | Australia/Melbourne            |
                  | Melbourne                     | Australia/Melbourne            |
                  | Sydney                        | Australia/Sydney               |
                  | Brisbane                      | Australia/Brisbane             |
                  | Hobart                        | Australia/Hobart               |
                  | Vladivostok                   | Asia/Vladivostok               |
                  | Guam                          | Pacific/Guam                   |
                  | Port Moresby                  | Pacific/Port_Moresby           |
                  | Magadan                       | Asia/Magadan                   |
                  | Srednekolymsk                 | Asia/Srednekolymsk             |
                  | Solomon Is.                   | Pacific/Guadalcanal            |
                  | New Caledonia                 | Pacific/Noumea                 |
                  | Fiji                          | Pacific/Fiji                   |
                  | Kamchatka                     | Asia/Kamchatka                 |
                  | Marshall Is.                  | Pacific/Majuro                 |
                  | Auckland                      | Pacific/Auckland               |
                  | Wellington                    | Pacific/Auckland               |
                  | Nuku'alofa                    | Pacific/Tongatapu              |
                  | Tokelau Is.                   | Pacific/Fakaofo                |
                  | Chatham Is.                   | Pacific/Chatham                |
                  | Samoa                         | Pacific/Apia                   |

                </details>


                **Default:** `Etc/UTC`


                **Example:** `America/New_York`
      example:
        live_stream:
          billing_mode: pay_as_you_go
          broadcast_location: us_west_oregon
          description: This is my first live stream.
          encoder: other_webrtc
          name: My Live Stream
          transcoder_type: transcoded
    hosted_page_response_object:
      type: object
      description: Configuration of the hosted page.
      properties:
        enabled:
          type: boolean
          description: >-
            A web page hosted by Wowza Video that includes a player for the live
            stream. The default, **true**, creates a hosted page. Specify
            **false** to not create a hosted web page.
          example: ''
        description:
          type: string
          description: >-
            A description that appears on the hosted page below the player.
            Can't include custom HTML, JavaScript, or other tags.
          example: ''
        logo_image_url:
          type: string
          description: >-
            The path to a GIF, JPEG, or PNG logo file that appears in the
            upper-left corner of the hosted page. Logo file must be 2.5 MB or
            smaller.
        sharing_icons:
          type: boolean
          description: >-
            Icons that let viewers share the stream on Facebook, Google+,
            Twitter, and by email. The default, **true**, includes sharing icons
            on the hosted page. Specify **false** to omit sharing icons.
          example: ''
        title:
          type: string
          description: >-
            A title for the page that appears above the player. Can't include
            custom HTML, JavaScript, or other tags.
          example: ''
        url:
          type: string
          description: >-
            The URL of the Wowza Video-hosted webpage that viewers can visit to
            watch the stream.
          example: ''
    live_stream:
      type: object
      description: ''
      properties:
        aspect_ratio_height:
          type: integer
          description: >-
            The height, in pixels, of the video source. Should correspond to a
            widescreen (16:9) or standard (4:3) aspect ratio and be divisible by
            8. Combined with **aspect_ratio_width**, makes up the input
            resolution.


            Default: **720**.
          example: ''
          format: int32
        aspect_ratio_width:
          type: integer
          description: >-
            The width, in pixels, of the video source. Should correspond to a
            widescreen (16:9) or standard (4:3) aspect ratio and be divisible by
            8. Combined with **aspect_ratio_height**, makes up the input
            resolution.


            Default: **1280**.
          example: ''
          format: int32
        asset_id:
          type: string
          description: >-
            Only applies to live streams created from re-streaming an asset in
            Asset Management. The id for the asset associated with the
            re-streamed live stream. You can manage this asset in Asset
            Management.
        billing_mode:
          type: string
          description: >-

            The billing mode for the stream. 



            Default: **pay_as_you_go**.


                    
            **pay_as_you_go** — Billed as a single event. A single event is
            use-based and you incur charges for the time spent streaming.
                
            **twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel is
            unlimited stream time for one channel. This billing mode doesn't
            incur overages, since it's unlimited.
          example: ''
          enum:
            - pay_as_you_go
            - twentyfour_seven
        broadcast_location:
          $ref: '#/components/schemas/broadcast_location'
        closed_caption_type:
          type: string
          description: >-
            The type of closed caption data being passed from the source. The
            default, **none**, indicates that no data is being provided. **cea**
            indicates that a CEA closed captioning data stream is being
            provided. **on_text** indicates that an onTextData closed captioning
            data stream is being provided. **both** indicates that both CEA and
            onTextData closed captioning data streams are being provided.
          example: ''
          enum:
            - none
            - cea
            - on_text
            - both
        connection_code:
          type: string
          description: >-
            A six-character, alphanumeric string that allows certain encoders,
            including Wowza Streaming Engine and the Wowza GoCoder app, to
            connect with Wowza Video. The code can be used once and expires 24
            hours after it's created.
          example: ''
        connection_code_expires_at:
          type: string
          description: The date and time that the *connection_code* expires.
          example: ''
          format: date-time
        created_at:
          type: string
          description: The date and time that the live stream was created.
          example: ''
          format: date-time
        delivery_method:
          type: string
          description: >-
            The type of connection between the video source and the transcoder.
            The default, **push**, instructs the source to push the stream to
            the transcoder. **pull** instructs the transcoder to pull the video
            from the source. **cdn** uses a stream source to deliver the stream
            to the transcoder.
          example: ''
          enum:
            - pull
            - cdn
            - push
        delivery_protocols:
          type: array
          description: >-
            An array of direct delivery protocols enabled for this live stream.
            By default, **rtmp**, **rtsp**, **webrtc**, and **wowz** are
            enabled.
          items:
            type: string
        description:
          type: string
          description: An optional description of the live stream.
          example: ''
        direct_playback_urls:
          type: object
          description: >-
            A list of direct playback URLs for the live stream's delivery
            protocols. Each protocol has a URL for the source and a URL for each
            output rendition.
          properties:
            delivery_protocol:
              type: array
              description: The name of the direct playback protocol.
              items:
                type: object
                title: direct_playback_url
                properties:
                  name:
                    type: string
                    description: |-
                      The name of the playback URL: **source**, **default**,
                       or the output rendition's resolution.
                    example: ''
                  output_id:
                    type: string
                    description: >-
                      Only for output rendition-based playback URLs, not source
                      playback URLs. The unique alphanumeric string that
                      identifies the output rendition.
                    example: dcxq5q6c
                  url:
                    type: string
                    description: The playback URL for the source or output rendition.
                    example: >-
                      https://abcdef.dev.entrypoint.video.wowza.com/app-B8P6K226/ngrp:43a23e5a_all/playlist.m3u8
                  application_name:
                    type: string
                    description: (WebRTC only) The application name for the WebRTC output.
                    example: ''
                  stream_name:
                    type: string
                    description: >-
                      (WebRTC only) The stream name for the WebRTC output
                      rendition.
                    example: ''
        encoder:
          type: string
          description: >-
            The video source for the live stream. Choose the type of camera or
            encoder you're using to connect to the Wowza Video transcoder. If
            your specific device isn't listed, choose **ipcamera**,
            **other_rtmp**, or **other_rtsp**.
          example: ''
          enum:
            - wowza_clearcaster
            - wowza_gocoder
            - wowza_streaming_engine
            - media_ds
            - axis
            - epiphan
            - file
            - hauppauge
            - jvc
            - live_u
            - matrox
            - newtek_tricaster
            - osprey
            - sony
            - telestream_wirecast
            - teradek_cube
            - vmix
            - x_split
            - ipcamera
            - other_rtmp
            - other_rtsp
            - other_webrtc
            - other_udp
            - other_srt
        flowplayer:
          type: boolean
          description: >-
            Indicates whether or not the player for the live stream is a Wowza
            Flowplayer player. **True** indicates the player is a Wowza
            Flowplayer player. Our new Wowza Video experience uses Wowza
            Flowplayer. If you are a Wowza Video legacy subscriber, Wowza
            Flowplayer is also the player used. 


            **False** indicates the player is either an **original_html5**
            player or **wowza_player**. The original HTML 5 and Wowza players
            are the players available for Wowza Streaming Cloud subscribers. 
          example: ''
        hosted_page:
          $ref: '#/components/schemas/hosted_page_response_object'
        id:
          type: string
          description: The unique alphanumeric string that identifies the live stream.
          example: ''
        low_latency:
          type: boolean
          description: >-
            For streams whose *target_delivery_protocol* is **hls-https**. If
            **true**, turns off incoming and sort packet buffers and delivers
            smaller video packets to the player, which can reduce latency as
            long as networks can handle the increased overhead. The default is
            **false**.
          example: ''
        name:
          type: string
          description: A descriptive name for the live stream. Maximum 200 characters.
          example: ''
        playback_stream_name:
          type: string
          description: The stream name used in the direct playback URL.
          example: ''
        player_id:
          type: string
          description: >-
            (Available from version 2.0) The unique alphanumeric string that
            identifies the player configuration to use for this stream. 
                
                
            When you pass a player configuration ID, Wowza Video uses that
            player configuration to customize and style the player. If you don't
            pass a value, the default player configuration for the account is
            used.


            Create and edit player configurations in the user interface. The ID
            is on the **General** tab for the player configuration.


            **Default**: Default player configuration

            <blockquote><strong>Note</strong>: <strong>player_id</strong> is not
            returned in the response if it's not explicitly sent and the default
            player configuration is used instead.</blockquote>


            **Example**: 2205b4e8-b160-43c2-868d-d88698a4e850
        player_type:
          type: string
          description: >-
            (Available from version 2.0) The type of player associated with the
            stream. Streams created in legacy Wowza Video have a  player type of
            *wowza_flowplayer_v1*. Streams created in later versions of Wowza
            Video have a player type of *wowza_flowplayer_v2*.


            Knowing the player type is useful if you've migrated streams from
            legacy Wowza Video. The player for a stream created in the legacy
            version of Wowza Video isn't editable in the new platform. 


            **Example**: wowza_flowplayer_v1
          enum:
            - wowza_flowplayer_v1
            - wowza_flowplayer_v2
        embed_code:
          type: string
          description: >-
            The HTML code that can be used in an external webpage to host the
            Wowza Flowplayer.
          example: ''
        hls_playback_url:
          type: string
          description: >-
            The address that can be used to configure playback of the stream
            using the HLS protocol.
          example: ''
        countdown_at:
          type: string
          description: >-
            The month, day, year, and time of day that the countdown timer
            should stop displaying to the viewer. Specify **YYYY-MM-DD 
            HH:MM:SS** where **HH** is a 24-hour clock. The response is in UTC
            time.
                
                
                
            For example, if you set the **countdown_at** for
            **2024-12-15T17:00:00:000Z** and the **countdown_timezone** as 
            **America/New_York**, the viewer would see their current time minus
            the time remaining until the date and time you set. So, if there's 5
            hours  to go until 1700 NYC time for the viewer, the viewer sees
            **5:00:00** on the player indicating there are 5 hours left, then
            the timer counts down from there. The countdown starts as soon as
            the streamer configures it.


            Required when **countdown** is **true**.


            **Example:** <code>"countdown_at": "2024-02-01T00:00:00.000Z"
          example: '2024-02-01T00:00:00.000Z'
          format: date-time
        countdown_timezone:
          type: string
          example: America/New_York
          description: >-
            The time zone the countdown timer runs in.


            Required when **countdown** is **true**.

              
            <details> <summary>Click to expand for the full list of valid
            values</summary>

              | Locations                     |  Wowza Video time_zone value |
              |---|---|
              | International Date Line West  | Etc/GMT+12                     |
              | Midway Island                 | Pacific/Midway                 |
              | American Samoa                | Pacific/Pago_Pago              |
              | Hawaii                        | Pacific/Honolulu               |
              | Alaska                        | America/Juneau                 |
              | Pacific Time (US & Canada)    | America/Los_Angeles            |
              | Tijuana                       | America/Tijuana                |
              | Mountain Time (US & Canada)   | America/Denver                 |
              | Arizona                       | America/Phoenix                |
              | Chihuahua                     | America/Chihuahua              |
              | Mazatlan                      | America/Mazatlan               |
              | Central Time (US & Canada)    | America/Chicago                |
              | Saskatchewan                  | America/Regina                 |
              | Guadalajara                   | America/Mexico_City            |
              | Mexico City                   | America/Mexico_City            |
              | Monterrey                     | America/Monterrey              |
              | Central America               | America/Guatemala              |
              | Eastern Time (US & Canada)    | America/New_York               |
              | Indiana (East)                | America/Indiana/Indianapolis   |
              | Bogota                        | America/Bogota                 |
              | Lima                          | America/Lima                   |
              | Quito                         | America/Lima                   |
              | Atlantic Time (Canada)        | America/Halifax                |
              | Caracas                       | America/Caracas                |
              | La Paz                        | America/La_Paz                 |
              | Santiago                      | America/Santiago               |
              | Newfoundland                  | America/St_Johns               |
              | Brasilia                      | America/Sao_Paulo              |
              | Buenos Aires                  | America/Argentina/Buenos_Aires |
              | Montevideo                    | America/Montevideo             |
              | Georgetown                    | America/Guyana                 |
              | Puerto Rico                   | America/Puerto_Rico            |
              | Greenland                     | America/Godthab                |
              | Mid-Atlantic                  | Atlantic/South_Georgia         |
              | Azores                        | Atlantic/Azores                |
              | Cape Verde Is.                | Atlantic/Cape_Verde            |
              | Dublin                        | Europe/Dublin                  |
              | Edinburgh                     | Europe/London                  |
              | Lisbon                        | Europe/Lisbon                  |
              | London                        | Europe/London                  |
              | Casablanca                    | Africa/Casablanca              |
              | Monrovia                      | Africa/Monrovia                |
              | UTC                           | Etc/UTC                        |
              | Belgrade                      | Europe/Belgrade                |
              | Bratislava                    | Europe/Bratislava              |
              | Budapest                      | Europe/Budapest                |
              | Ljubljana                     | Europe/Ljubljana               |
              | Prague                        | Europe/Prague                  |
              | Sarajevo                      | Europe/Sarajevo                |
              | Skopje                        | Europe/Skopje                  |
              | Warsaw                        | Europe/Warsaw                  |
              | Zagreb                        | Europe/Zagreb                  |
              | Brussels                      | Europe/Brussels                |
              | Copenhagen                    | Europe/Copenhagen              |
              | Madrid                        | Europe/Madrid                  |
              | Paris                         | Europe/Paris                   |
              | Amsterdam                     | Europe/Amsterdam               |
              | Berlin                        | Europe/Berlin                  |
              | Bern                          | Europe/Zurich                  |
              | Zurich                        | Europe/Zurich                  |
              | Rome                          | Europe/Rome                    |
              | Stockholm                     | Europe/Stockholm               |
              | Vienna                        | Europe/Vienna                  |
              | West Central Africa           | Africa/Algiers                 |
              | Bucharest                     | Europe/Bucharest               |
              | Cairo                         | Africa/Cairo                   |
              | Helsinki                      | Europe/Helsinki                |
              | Kyiv                          | Europe/Kiev                    |
              | Riga                          | Europe/Riga                    |
              | Sofia                         | Europe/Sofia                   |
              | Tallinn                       | Europe/Tallinn                 |
              | Vilnius                       | Europe/Vilnius                 |
              | Athens                        | Europe/Athens                  |
              | Istanbul                      | Europe/Istanbul                |
              | Minsk                         | Europe/Minsk                   |
              | Jerusalem                     | Asia/Jerusalem                 |
              | Harare                        | Africa/Harare                  |
              | Pretoria                      | Africa/Johannesburg            |
              | Kaliningrad                   | Europe/Kaliningrad             |
              | Moscow                        | Europe/Moscow                  |
              | St. Petersburg                | Europe/Moscow                  |
              | Volgograd                     | Europe/Volgograd               |
              | Samara                        | Europe/Samara                  |
              | Kuwait                        | Asia/Kuwait                    |
              | Riyadh                        | Asia/Riyadh                    |
              | Nairobi                       | Africa/Nairobi                 |
              | Baghdad                       | Asia/Baghdad                   |
              | Tehran                        | Asia/Tehran                    |
              | Abu Dhabi                     | Asia/Muscat                    |
              | Muscat                        | Asia/Muscat                    |
              | Baku                          | Asia/Baku                      |
              | Tbilisi                       | Asia/Tbilisi                   |
              | Yerevan                       | Asia/Yerevan                   |
              | Kabul                         | Asia/Kabul                     |
              | Ekaterinburg                  | Asia/Yekaterinburg             |
              | Islamabad                     | Asia/Karachi                   |
              | Karachi                       | Asia/Karachi                   |
              | Tashkent                      | Asia/Tashkent                  |
              | Chennai                       | Asia/Kolkata                   |
              | Kolkata                       | Asia/Kolkata                   |
              | Mumbai                        | Asia/Kolkata                   |
              | New Delhi                     | Asia/Kolkata                   |
              | Kathmandu                     | Asia/Kathmandu                 |
              | Astana                        | Asia/Dhaka                     |
              | Dhaka                         | Asia/Dhaka                     |
              | Sri Jayawardenepura           | Asia/Colombo                   |
              | Almaty                        | Asia/Almaty                    |
              | Novosibirsk                   | Asia/Novosibirsk               |
              | Rangoon                       | Asia/Rangoon                   |
              | Bangkok                       | Asia/Bangkok                   |
              | Hanoi                         | Asia/Bangkok                   |
              | Jakarta                       | Asia/Jakarta                   |
              | Krasnoyarsk                   | Asia/Krasnoyarsk               |
              | Beijing                       | Asia/Shanghai                  |
              | Chongqing                     | Asia/Chongqing                 |
              | Hong Kong                     | Asia/Hong_Kong                 |
              | Urumqi                        | Asia/Urumqi                    |
              | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
              | Singapore                     | Asia/Singapore                 |
              | Taipei                        | Asia/Taipei                    |
              | Perth                         | Australia/Perth                |
              | Irkutsk                       | Asia/Irkutsk                   |
              | Ulaanbaatar                   | Asia/Ulaanbaatar               |
              | Seoul                         | Asia/Seoul                     |
              | Osaka                         | Asia/Tokyo                     |
              | Sapporo                       | Asia/Tokyo                     |
              | Tokyo                         | Asia/Tokyo                     |
              | Yakutsk                       | Asia/Yakutsk                   |
              | Darwin                        | Australia/Darwin               |
              | Adelaide                      | Australia/Adelaide             |
              | Canberra                      | Australia/Melbourne            |
              | Melbourne                     | Australia/Melbourne            |
              | Sydney                        | Australia/Sydney               |
              | Brisbane                      | Australia/Brisbane             |
              | Hobart                        | Australia/Hobart               |
              | Vladivostok                   | Asia/Vladivostok               |
              | Guam                          | Pacific/Guam                   |
              | Port Moresby                  | Pacific/Port_Moresby           |
              | Magadan                       | Asia/Magadan                   |
              | Srednekolymsk                 | Asia/Srednekolymsk             |
              | Solomon Is.                   | Pacific/Guadalcanal            |
              | New Caledonia                 | Pacific/Noumea                 |
              | Fiji                          | Pacific/Fiji                   |
              | Kamchatka                     | Asia/Kamchatka                 |
              | Marshall Is.                  | Pacific/Majuro                 |
              | Auckland                      | Pacific/Auckland               |
              | Wellington                    | Pacific/Auckland               |
              | Nuku'alofa                    | Pacific/Tongatapu              |
              | Tokelau Is.                   | Pacific/Fakaofo                |
              | Chatham Is.                   | Pacific/Chatham                |
              | Samoa                         | Pacific/Apia                   |

            </details>


            **Default:** `Etc/UTC`


            **Example:** `America/New_York`
        countdown:
          type: boolean
          description: 'Enables or disables a countdown timer. '
          example: ''
        logo_image_url:
          type: string
          description: >-
            The path to a GIF, JPEG, or PNG logo file that appears partially
            transparent in a corner of the player throughout playback. Logo file
            must be 2.5 MB or smaller.
          example: ''
        logo_position:
          type: string
          description: >-
            The corner of the player in which you want the player logo to
            appear. The default is **top-left**.
          example: ''
          enum:
            - top-left
            - top-right
            - bottom-left
            - bottom-right
        video_poster_image_url:
          type: string
          description: >-
            The path to a GIF, JPEG, or PNG poster image that appears in the
            player before the stream begins. Poster image files must be 2.5 MB
            or smaller.
          example: ''
        width:
          type: integer
          description: >-
            The width, in pixels, of a fixed-size player. The default is
            **640**.
          example: ''
          format: int32
        recording:
          type: boolean
          description: >-
            If **true**, creates a recording of the live stream. The recording
            starts when the live stream starts and stops automatically when the
            live stream stops.


            Recordings created from a live stream capture up to eight hours of
            content.

            If a live stream runs for longer than eight hours, the most recent
            eight hours are recorded. To record more than eight hours of a
            single broadcast, stop the live stream and start it again to create
            multiple recordings.


            Default: **false**.


            > **Note**: If **save_asset** is **true**, that field overrides a
            true **recording** value and the asset is saved in Asset Management.
          example: ''
        reference_id:
          type: string
          description: >-
            A unique, alphanumeric ID returned in transcoder webhook payloads.
            Setting a *reference_id* is useful if you have an ID in your system
            or application you want to associate with transcoder events that
            trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z
            0-9 !@#$%^&*()-_+=:;,.?~|


            You can't use brackets or quotation marks.


            See <a
            href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza
            Video Webhook Event Reference Documentation</a> to learn about
            webhooks.


            Available from version 1.7.
          example: ''
        save_asset:
          type: boolean
          description: >-
            If **true**, saves an MP4 recording and a VOD asset in Asset
            Management. The default is **false**. You can't set **save_asset**
            for a live stream created from re-streaming an asset in Asset
            Management.

            > **Note**: If this value is true, **recording** and/or
            **vod_stream** are set to false. You need a Wowza Video subscription
            to access Asset Management.


            Available from version 1.8.
        security:
          type: object
          description: >-
            Configuration of stream security. These settings only apply to Wowza
            CDN on Fastly stream targets, not Facebook Live, LinkedIn Live, or
            custom targets.
          properties:
            force_ssl_playback:
              type: boolean
              description: >-
                If **true**, requires users to play the stream over HTTPS. If
                **false**, the default, users can play the stream over HTTPS or
                HTTP.
              example: ''
            geoblock_enabled:
              type: boolean
              description: >-
                If **true**, controls access to the stream from specific
                locations and, optionally, IP addresses. The default is
                **false**.
              example: ''
            geoblock_by_location:
              type: string
              description: >-
                Specifies whether to **allow** or **deny** access to the stream
                from specific locations. The default is **disabled**.
              example: ''
              enum:
                - allow
                - deny
                - disabled
            geoblock_country_codes:
              type: string
              description: >-
                Required when *geoblock_by_location* is **allow** or **deny**.
                The locations affected by the geo-blocking. Enter a
                comma-separated list of capitalized two-letter ISO 3166-1
                country codes. For a list, see [ISO
                3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on Wikipedia.
              example: ''
            geoblock_ip_override:
              type: string
              description: >-
                Specifies whether specific IP addresses can override the
                locations that are allowed or restricted. **allow** permits
                access from IP addresses within a location that's been blocked,
                while **deny** restricts access from IP addresses within
                locations that are allowed. The default is **disabled**.
              example: ''
              enum:
                - allow
                - deny
                - disabled
            geoblock_ip_addresses:
              type: string
              description: >-
                Required when *geoblock_ip_override* is **allow** or **deny**.
                Addresses that can access or restrict the stream even if they're
                within a specified geo-blocked location. Enter a comma-separated
                list of IPv4 and IPv6 IP addresses that always allow or deny
                streaming based on the *geoblock_ip_override* value.
              example: ''
            token_auth_enabled:
              type: boolean
              description: >-
                If **true**, token authentication protects the stream by
                ensuring that it's delivered only to authorized viewers and
                can't be shared by unauthorized links or player hijacking
                attacks. The default is **false**.
              example: ''
            token_auth_shared_secret:
              type: string
              description: >-
                The shared secret of the token authentication. Must contain only
                hexadecimal characters and be an even number of total characters
                not exceeding 32.
              example: ''
            token_auth_playlist_only:
              type: boolean
              description: >-
                If **true**, Wowza Video uses token authentication to protect
                the master playlist only and leaves individual media playlists
                and media segments unprotected.  This feature enables playback
                compatibility with media players that don’t support the
                *withCredentials* property. It may also be useful when
                addressing  token auth compatibility issues with specific
                browsers. The default is **false**.


                **Note**: If you've enabled MPEG-DASH on your stream target,
                `token_auth_playlist_only` applies to both the `playlist.m3u8`
                for HLS and `manifest.mpd` for MPEG-DASH.
              example: ''
        source_connection_information:
          type: object
          description: >-
            Details that you can use to manually configure and connect a video
            source to the live stream.
          example: ''
        state:
          type: string
          description: The state of the live stream.
          example: started
          enum:
            - starting
            - stopping
            - started
            - stopped
            - resetting
        stream_source_id:
          type: string
          description: >-
            The unique alphanumeric string that identifies the stream source, if
            a stream source is used.
          example: ''
        stream_targets:
          type: array
          description: >-
            An array of unique alphanumeric strings that identify the stream
            targets used by the live stream. A **primary_stream_target** is a
            single stream target that automatically  gets created for all output
            renditions (the ABR ladder) created when you create a live stream 
            through a live stream flow. The **primary_stream_target** cannot be
            deleted or reassigned.
          items:
            type: object
            title: stream_targets
            properties:
              id:
                type: string
                description: >-
                  The unique alphanumeric string that identifies the stream
                  target.
                example: dcxq5q6c
        target_delivery_protocol:
          type: string
          description: >-
            The type of stream being delivered from Wowza Video. The default and
            only valid value is **hls-https**.
          example: ''
          enum:
            - hls-https
        transcoder_type:
          type: string
          description: >-
            The type of transcoder, either **transcoded** for streams that are
            transcoded into adaptive bitrate renditions or **passthrough** for
            streams that aren't processed by the transcoder. 



            > **Note**: **passthrough** isn't supported in the
            **asia_pacific_singapore** region.



            Default: **transcoded**.
          example: ''
          enum:
            - transcoded
            - passthrough
        updated_at:
          type: string
          description: The date and time that the live stream was updated.
          example: ''
          format: date-time
        use_stream_source:
          type: boolean
          description: >-
            If **true**, uses a stream source to deliver the stream to Wowza
            Video. The default, **false**, pushes directly to Wowza Video.
          example: ''
        vod_stream:
          type: boolean
          description: >-
            If **true**, creates a VOD stream after the live stream ends. The
            default is **false**. VOD streams require a Fastly stream target
            with HLS as a delivery protocol.

            > **Note**: If **save_asset** is **true**, that field overrides a
            true **vod_stream** value and the asset is saved in Asset
            Management.
          example: ''
        watermark:
          type: boolean
          description: >-
            Embeds an image into the transcoded stream for copyright protection.
            Specify **true** to embed a watermark image.
          example: ''
        watermark_height:
          type: integer
          description: >-
            The height, in pixels, of the watermark image. If blank, Wowza Video
            uses the original image height.
          example: ''
          format: int32
        watermark_image_url:
          type: string
          description: >-
            The path to a GIF, JPEG, or PNG image that is embedded in all
            bitrate renditions of the stream. Watermark image files must be 2.5
            MB or smaller.
          example: ''
        watermark_opacity:
          type: integer
          description: >-
            The opacity, or percentage of transparency, of the watermark. **0**
            is fully transparent; **100** is fully opaque.
          example: ''
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
            - 16
            - 17
            - 18
            - 19
            - 20
            - 21
            - 22
            - 23
            - 24
            - 25
            - 26
            - 27
            - 28
            - 29
            - 30
            - 31
            - 32
            - 33
            - 34
            - 35
            - 36
            - 37
            - 38
            - 39
            - 40
            - 41
            - 42
            - 43
            - 44
            - 45
            - 46
            - 47
            - 48
            - 49
            - 50
            - 51
            - 52
            - 53
            - 54
            - 55
            - 56
            - 57
            - 58
            - 59
            - 60
            - 61
            - 62
            - 63
            - 64
            - 65
            - 66
            - 67
            - 68
            - 69
            - 70
            - 71
            - 72
            - 73
            - 74
            - 75
            - 76
            - 77
            - 78
            - 79
            - 80
            - 81
            - 82
            - 83
            - 84
            - 85
            - 86
            - 87
            - 88
            - 89
            - 90
            - 91
            - 92
            - 93
            - 94
            - 95
            - 96
            - 97
            - 98
            - 99
            - 100
          format: int32
        watermark_position:
          type: string
          description: >-
            The corner of the video frame in which you want the watermark to
            appear. The default is **top-left**.
          example: ''
          enum:
            - top-left
            - top-right
            - bottom-left
            - bottom-right
        watermark_width:
          type: integer
          description: >-
            The width, in pixels, of the watermark image. If blank, Wowza Video
            uses the original image width.
          example: ''
          format: int32
      example:
        aspect_ratio_height: 720
        aspect_ratio_width: 1280
        billing_mode: pay_as_you_go
        broadcast_location: us_west_california
        closed_caption_type: cea
        connection_code: 0e15cb
        connection_code_expires_at: '2020-11-30T17:16:21.956Z'
        created_at: '2020-01-29T17:16:21.956Z'
        delivery_method: push
        delivery_protocols:
          - rtmp
          - rtsp
          - wowz
          - webrtc
        description: This is my first live stream.
        direct_playback_urls:
          rtmp:
            - name: source
              url: rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789
            - name: webrtc
              output_id: dcxq5q6c
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1
            - name: V:1280x720+A:128K
              output_id: 0g116zkf
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2
            - name: V:854x480+A:128K
              output_id: 4qqkwndt
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3
            - name: V:640x360+A:128K
              output_id: 0pv8djpg
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4
            - name: V:512x288+A:128K
              output_id: b09xrxjf
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5
            - name: V:320x180+A:128K
              output_id: bvkh2nsz
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6
          rtsp:
            - name: source
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789
            - name: webrtc
              output_id: dcxq5q6c
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1
            - name: V:1280x720+A:128K
              output_id: 0g116zkf
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2
            - name: V:854x480+A:128K
              output_id: 4qqkwndt
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3
            - name: V:640x360+A:128K
              output_id: 0pv8djpg
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4
            - name: V:512x288+A:128K
              output_id: b09xrxjf
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5
            - name: V:320x180+A:128K
              output_id: bvkh2nsz
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6
          wowz:
            - name: source
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789
            - name: webrtc
              output_id: dcxq5q6c
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1
            - name: V:1280x720+A:128K
              output_id: 0g116zkf
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2
            - name: V:854x480+A:128K
              output_id: 4qqkwndt
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3
            - name: V:640x360+A:128K
              output_id: 0pv8djpg
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4
            - name: V:512x288+A:128K
              output_id: b09xrxjf
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5
            - name: V:320x180+A:128K
              output_id: bvkh2nsz
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6
          webrtc:
            - name: source
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead
            - name: webrtc
              output_id: dcxq5q6c
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream1
            - name: V:1280x720+A:128K
              output_id: 0g116zkf
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream2
            - name: V:854x480+A:128K
              output_id: 4qqkwndt
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream3
            - name: V:640x360+A:128K
              output_id: 0pv8djpg
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream4
            - name: V:512x288+A:128K
              output_id: b09xrxjf
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream5
            - name: V:320x180+A:128K
              output_id: bvkh2nsz
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream6
        encoder: other_rtmp
        flowplayer: true
        hosted_page:
          enabled: true
          description: My Hosted Page Description
          logo_image_url: >-
            https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg
          sharing_icons: true
          title: My Hosted Page
          url: https://embed.flowplayer.com/hosted/default/e8dk5bf6
        id: wdjfqvsv
        name: My PAYG Transcoded WSE Live Stream
        playback_stream_name: wxyz6789
        player_id: 205b4e8-b160-43c2-868d-d88698a4e850
        player_type: wowza_flowplayer_v2
        embed_code: null
        hls_playback_url: >-
          https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8
        logo_image_url: >-
          https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg
        logo_position: top-right
        video_poster_image_url: >-
          https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg
        width: 640
        recording: true
        reference_id: mySystemID_01
        save_asset: false
        security:
          force_ssl_playback: false
          geoblock_enabled: true
          geoblock_by_location: allow
          geoblock_country_codes: DE, US
          geoblock_ip_override: deny
          geoblock_ip_addresses: 77.12.34.567, 78.23.45.678
          token_auth_enabled: false
          token_auth_playlist_only: false
        state: stopped
        stream_source_id: 5skrfpyf
        stream_targets:
          - id: klbmg2h8
          - id: bnjtdmmc
        target_delivery_protocol: hls-https
        transcoder_type: transcoded
        updated_at: '2020-01-31T06:12:39.956Z'
        use_stream_source: true
        vod_stream: true
        watermark: true
        watermark_height: 80
        watermark_image_url: >-
          https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg
        watermark_opacity: 75
        watermark_position: top-right
        watermark_width: 100
    Error422:
      type: object
      description: ''
      required:
        - meta
      properties:
        meta:
          type: object
          title: meta
          description: ''
          properties:
            status:
              type: integer
              description: ''
              example: ''
              format: int32
            code:
              type: string
              description: ''
              example: ''
            title:
              type: string
              description: ''
              example: ''
            message:
              type: string
              description: ''
              example: ''
            description:
              type: string
              description: ''
              example: ''
            links:
              type: array
              description: ''
              example: ''
              items: {}
      example:
        Example Response 1:
          meta:
            status: 422
            code: ERR-422-RecordInvalid
            title: Record Invalid Error
            message: The request couldn't be processed. ... can't be blank
            description: ''
            links: []
        Example Response 2:
          meta:
            status: 422
            code: ERR-422-RecordInvalid
            title: Record Invalid Error
            message: >-
              The request couldn't be processed. Provider wowza_video is not
              allowed
            description: ''
            links: []
        Example Response 3:
          meta:
            status: 422
            code: ERR-422-InvalidStateChange
            title: Invalid State Change Error
            message: >-
              The request couldn't be processed. There must be at least one
              WebRTC output for this transcoder.
            description: ''
            links: []
        Example Response 4:
          meta:
            status: 422
            code: ERR-422-RecordInvalid
            title: Record Invalid Error
            message: >-
              API cannot remove the primary Output Stream Target with the ID of
              <output id> from the Live Stream <livestream id><livestream name>.
            description: ''
            links: []
        Example Response 5:
          meta:
            status: 422
            code: ERR-422-InvalidStateChange
            title: Invalid State Change Error
            message: >-
              The request couldn't be processed. The broadcast location can't be
              updated when using autostart.
            description: ''
            links: []
        Example Response 6:
          meta:
            status: 422
            code: ERR-422-RecordInvalid
            title: Record Invalid Error
            message: Instance value not found in enum.
            description: ''
            links: []
    Error403:
      type: object
      description: ''
      required:
        - meta
      properties:
        meta:
          type: object
          title: meta
          description: ''
          properties:
            status:
              type: integer
              description: ''
              example: ''
              format: int32
            code:
              type: string
              description: ''
              example: ''
            title:
              type: string
              description: ''
              example: ''
            message:
              type: string
              description: ''
              example: ''
            description:
              type: string
              description: ''
              example: ''
            links:
              type: array
              description: ''
              example: ''
              items: {}
      example:
        Example Response 1:
          meta:
            status: 403
            code: ERR-403-RecordUnaccessible
            title: Record Unaccessible Error
            message: The requested resource isn't accessible.
            description: ''
            links: []
    Error404:
      type: object
      description: ''
      required:
        - meta
      properties:
        meta:
          type: object
          title: meta
          description: ''
          properties:
            status:
              type: integer
              description: ''
              example: ''
              format: int32
            code:
              type: string
              description: ''
              example: ''
            title:
              type: string
              description: ''
              example: ''
            message:
              type: string
              description: ''
              example: ''
            description:
              type: string
              description: ''
              example: ''
            links:
              type: array
              description: ''
              example: ''
              items: {}
      example:
        Example Response 1:
          meta:
            status: 404
            code: ERR-404-RecordNotFound
            title: Record Not Found Error
            message: The requested resource couldn't be found.
            description: ''
            links: []
    Error410:
      type: object
      description: ''
      required:
        - meta
      properties:
        meta:
          type: object
          title: meta
          description: ''
          properties:
            status:
              type: integer
              description: ''
              example: ''
              format: int32
            code:
              type: string
              description: ''
              example: ''
            title:
              type: string
              description: ''
              example: ''
            message:
              type: string
              description: ''
              example: ''
            description:
              type: string
              description: ''
              example: ''
            links:
              type: array
              description: ''
              example: ''
              items: {}
      example:
        Example Response 1:
          meta:
            status: 410
            code: ERR-410-RecordDeleted
            title: Record Deleted Error
            message: The requested resource has been deleted.
            description: ''
            links: []
    hosted_page_request_object:
      type: object
      description: Configuration of the hosted page.
      properties:
        enabled:
          type: boolean
          description: >-
            A web page hosted by Wowza Video that includes a player for the live
            stream. The default, **true**, creates a hosted page. Specify
            **false** to not create a hosted web page.


            **Example:** <code>"enabled": true</code>
          example: ''
        description:
          type: string
          description: >-
            A description that appears on the hosted page below the player.
            Can't include custom HTML, JavaScript, or other tags.


            **Example:** <code>"description": "My Hosted Page
            Description"</code>
          example: ''
        logo_image:
          type: string
          description: >-
            A Base64-encoded string representation of a GIF, JPEG, or PNG logo
            file that that appears in the upper-left corner of the hosted page.
            Logo file must be 2.5 MB or smaller.


            **Example:** <code>"logo_image": "[Base64-encoded string
            representation of GIF, JPEG, or PNG file]"</code>
          example: '[Base64-encoded string representation of GIF, JPEG, or PNG file]'
        remove_logo_image:
          type: boolean
          description: >-
            If **true**, removes the logo file from the hosted page. The default
            is **false**.


            **Example:** <code>"remove_logo_image": true</code>
          example: true
        sharing_icons:
          type: boolean
          description: >-
            Icons that let viewers share the stream on Facebook, Google+,
            Twitter, and by email. The default, **true**, includes sharing icons
            on the hosted page. Specify **false** to omit sharing icons.


            **Example:** <code>"sharing_icons": false</code>
          example: ''
        title:
          type: string
          description: >-
            A title for the page that appears above the player. Can't include
            custom HTML, JavaScript, or other tags.


            **Example:** <code>"title": "My Hosted Page"</code>
          example: ''
    live_stream_update_input:
      type: object
      description: ''
      required:
        - live_stream
      properties:
        live_stream:
          type: object
          title: live_stream
          description: ''
          properties:
            aspect_ratio_height:
              type: integer
              description: >-
                The height, in pixels, of the video source. Should correspond to
                a widescreen (16:9) or standard (4:3) aspect ratio and be
                divisible by 8. Combined with **aspect_ratio_width**, makes up
                the input resolution.


                Default: **720**.


                **Example:** <code>"aspect_ratio_height": 720</code>
              example: 1080
              format: int32
            aspect_ratio_width:
              type: integer
              description: >-
                The width, in pixels, of the video source. Should correspond to
                a widescreen (16:9) or standard (4:3) aspect ratio and be
                divisible by 8. Combined with **aspect_ratio_height**, makes up
                the input resolution.


                Default: **1280**.


                **Example:** <code>"aspect_ratio_width": 1280</code>
              example: 1920
              format: int32
            encoder:
              type: string
              description: >-
                The video source for the live stream. Choose the type of camera
                or encoder you're using to connect to the Wowza Video
                transcoder. If your specific device isn't listed, choose
                **ipcamera**, **other_rtmp**, or **other_rtsp**.


                **Example:** <code>"encoder": "other_rtmp"</code>
              example: other_rtmp
              enum:
                - wowza_clearcaster
                - wowza_gocoder
                - wowza_streaming_engine
                - media_ds
                - axis
                - epiphan
                - file
                - hauppauge
                - jvc
                - live_u
                - matrox
                - newtek_tricaster
                - osprey
                - sony
                - telestream_wirecast
                - teradek_cube
                - vmix
                - x_split
                - ipcamera
                - other_rtmp
                - other_rtsp
                - other_webrtc
                - other_udp
                - other_srt
            name:
              type: string
              description: |-
                A descriptive name for the live stream. Maximum 200 characters.

                **Example:** <code>"name": "My Updated Live Stream"</code>
              example: My Live Stream
            closed_caption_type:
              type: string
              description: >-
                The type of closed caption data being passed from the source.
                The default, **none**, indicates that no data is being provided.
                **cea** indicates that a CEA closed captioning data stream is
                being provided. **on_text** indicates that an onTextData closed
                captioning data stream is being provided. **both** indicates
                that both CEA and onTextData closed captioning data streams are
                being provided.


                **Example:** <code>"closed_caption_type": "cea"</code>
              example: cea
              enum:
                - none
                - cea
                - on_text
                - both
            delivery_method:
              type: string
              description: >-
                The type of connection between the video source and the
                transcoder. The default, **push**, instructs the source to push
                the stream to the transcoder. **pull** instructs the transcoder
                to pull the video from the source. **cdn** uses a stream source
                to deliver the stream to the transcoder.


                **Example:** <code>"delivery_method": "pull"</code>
              example: push
              enum:
                - pull
                - cdn
                - push
            delivery_protocols:
              type: array
              description: >-
                An array of direct delivery protocols enabled for this live
                stream. By default, **rtmp**, **rtsp**, **webrtc**, and **wowz**
                are enabled.


                **Example:** See response body sample
              items:
                type: string
            description:
              type: string
              description: An optional description of the live stream.
              example: ''
            disable_authentication:
              type: boolean
              description: >-
                Authentication is required by default for RTMP and RTSP push
                connections from a video source to Wowza Video. Specify **true**
                to disable authentication with the video source.


                **Example:** <code>"disable_authentication": false</code>
              example: false
            hosted_page:
              $ref: '#/components/schemas/hosted_page_request_object'
            password:
              type: string
              description: >-
                A password for authenticating an RTMP or RTSP push connection.
                Can contain only uppercase and lowercase letters; numbers; and
                the period (.), underscore (_), and hyphen (-) characters. No
                other special characters can be used.


                **Example:** <code>"password": 68332313</code>
              example: '68332313'
            player_id:
              type: string
              description: >-
                (Available from version 2.0) The unique alphanumeric string that
                identifies the player configuration to use for this stream. 


                When you pass a player configuration ID, Wowza Video uses that
                player configuration to customize and style the player. If you
                don't pass a value, the default player configuration for the
                account is used.


                Create and edit player configurations in the user interface. The
                ID is on the **General** tab for the player configuration.


                **Default**: Default player configuration


                **Example**: 2205b4e8-b160-43c2-868d-d88698a4e850
            logo_image:
              type: string
              description: >-
                A Base64-encoded string representation of a GIF, JPEG, or PNG
                logo  file that appears partially transparent in a corner of the
                player throughout playback. Logo file must be 2.5 MB or smaller.


                **Example:** <code>"logo_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>   
              example: ''
            logo_position:
              type: string
              description: >-
                The corner of the player in which you want the player logo to
                appear. The default is **top-left**.


                **Example:** <code>"logo_position": "top-right"</code>
              example: ''
              enum:
                - top-left
                - top-right
                - bottom-left
                - bottom-right
            video_poster_image:
              type: string
              description: >-
                The path to a GIF, JPEG, or PNG poster image that appears in the
                player before the stream begins. Poster image files must be 2.5
                MB or smaller.


                **Example:** <code>"video_poster_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>
              example: ''
            width:
              type: integer
              description: >-
                The width, in pixels, of a fixed-size player. The default is
                **640**.


                **Example:** <code>"width": 640</code>
              example: ''
              format: int32
            remove_logo_image:
              type: boolean
              description: >-
                If **true**, removes the logo file from the player. The default
                is **false**.


                **Example:** <code>"remove_logo_image": true</code>
              example: true
            remove_video_poster_image:
              type: boolean
              description: |-
                If **true**, removes the poster image. The default is **false**.

                **Example:** <code>"remove_video_poster_image": true</code>
              example: true
            recording:
              type: boolean
              description: >-
                If **true**, creates a recording of the live stream. The
                recording starts when the live stream starts and stops
                automatically when the live stream stops.


                Recordings created from a live stream capture up to eight hours
                of content. If a live stream runs for longer than eight hours,
                the most recent eight hours are recorded. To record more than
                eight hours of a single broadcast, stop the live stream and
                start it again to create multiple recordings.


                Default: **false**


                > **Note**: If **save_asset** is **true**, that field overrides
                a true **recording** value and the asset is saved in Asset
                Management.


                **Example:** <code>"recording": true</code>
              example: true
            reference_id:
              type: string
              description: >-
                A unique, alphanumeric ID returned in transcoder webhook
                payloads. Setting a *reference_id* is useful if you have an ID
                in your system or application you want to associate with
                transcoder events that trigger webhooks. Maximum 70 characters.
                Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|


                You can't use brackets or quotation marks.


                See <a
                href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza
                Video Webhook Event Reference Documentation</a> to learn about
                webhooks.


                Available from version 1.7.


                **Example:** <code>"reference_id": "mySystemID_01"</code>
              example: mySystemID_01
            save_asset:
              type: boolean
              description: >-
                If **true**, saves an MP4 recording and a VOD asset in Asset
                Management. The default is **false**. You can't set
                **save_asset** for a live stream created from re-streaming an
                asset in Asset Management

                > **Note**: If this value is true, **recording** and/or
                **vod_stream** are set to false. You need a Wowza Video
                subscription to access Asset Management.


                Available from version 1.8.


                **Example:** <code>"save_asset": true</code>
            security:
              type: object
              description: >-
                Configuration of stream security. These settings only apply to
                Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn
                Live, or custom targets.
              properties:
                force_ssl_playback:
                  type: boolean
                  description: >-
                    If **true**, requires users to play the stream over HTTPS.
                    If **false**, the default, users can play the stream over
                    HTTPS or HTTP.


                    **Example:** <code>"force_ssl_playback": true</code>
                  example: ''
                geoblock_enabled:
                  type: boolean
                  description: >-
                    If **true**, controls access to the stream from specific
                    locations and, optionally, IP addresses. The default is
                    **false**.


                    **Example:** <code>"geoblock_enabled": true</code>
                  example: ''
                geoblock_by_location:
                  type: string
                  description: >-
                    Specifies whether to **allow** or **deny** access to the
                    stream from specific locations. The default is **disabled**.


                    **Example:** <code>"geoblock_location": "allow"</code>
                  example: ''
                  enum:
                    - allow
                    - deny
                    - disabled
                geoblock_country_codes:
                  type: string
                  description: >-
                    Required when *geoblock_by_location* is **allow** or
                    **deny**. The locations affected by the geo-blocking. Enter
                    a comma-separated list of capitalized two-letter ISO 3166-1
                    country codes. For a list, see [ISO
                    3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on
                    Wikipedia.


                    **Example:** <code>"geoblock_country_codes": "CA, DE"</code>
                  example: ''
                geoblock_ip_override:
                  type: string
                  description: >-
                    Specifies whether specific IP addresses can override the
                    locations that are allowed or restricted. **allow** permits
                    access from IP addresses within a location that's been
                    blocked, while **deny** restricts access from IP addresses
                    within locations that are allowed. The default is
                    **disabled**.


                    **Example:** <code>"geoblock_ip_override": "allow"</code>
                  example: ''
                  enum:
                    - allow
                    - deny
                    - disabled
                geoblock_ip_addresses:
                  type: string
                  description: >-
                    Required when *geoblock_ip_override* is **allow** or
                    **deny**. Addresses that can access or restrict the stream
                    even if they're within a specified geo-blocked location.
                    Enter a comma-separated list of up to about 40 IPv4 and IPv6
                    IP addresses that always allow or deny streaming based on
                    the *geoblock_ip_override* value. 


                    <blockquote><strong>Troubleshooting:</strong> The limit of
                    40 IP addresses is approximate because  all the security
                    information (SSL playback, geoblocking countries and IP
                    addresses, referer header,  and token auth) count toward an
                    overall metadata limit.</blockquote>


                    **Example:** <code>"geoblock_ip_addresses": "77.12.34.567,
                    78.23.45.678"</code>
                  example: ''
                token_auth_enabled:
                  type: boolean
                  description: >-
                    If **true**, token authentication protects the stream by
                    ensuring that it's delivered only to authorized viewers and
                    can't be shared by unauthorized links or player hijacking
                    attacks. The default is **false**.


                    **Example:** <code>"token_auth_enabled": true</code>
                  example: ''
                token_auth_shared_secret:
                  type: string
                  description: >-
                    The shared secret of the token authentication. Must contain
                    only hexadecimal characters and be an even number of total
                    characters not exceeding 32.


                    **Example:** <code>"token_auth_shared_secret":
                    "12345678ABCDEF"</code>
                  example: ''
                token_auth_playlist_only:
                  type: boolean
                  description: >-
                    If **true**, Wowza Video uses token authentication to
                    protect the master playlist only and leaves individual media
                    playlists and media segments unprotected. This feature
                    enables playback compatibility with media players that don’t
                    support the *withCredentials* property. It may also be
                    useful when addressing token auth compatibility issues with
                    specific browsers. The default is **false**.


                    **Note**: If you've enabled MPEG-DASH on your stream target,
                    `token_auth_playlist_only` applies to both the
                    `playlist.m3u8` for HLS and `manifest.mpd` for MPEG-DASH.


                    **Example:** <code>"token_auth_playlist_only": true</code>
                  example: ''
            source_url:
              type: string
              description: >-
                For the *delivery_method* **pull** or *encoder* **file**.


                For **pull**, enter the URL of an IP camera or video encoder
                using an RTMP and RTSP pull connection to Wowza Video. Consult
                the camera or encoder documentation for the URL syntax.


                For **file**, enter the source file URL, including the protocol
                (http, https, gs, s3).



                **Example:** <code>"source_url":
                "xyz.streamlock.net/vod/mp4:Movie.mov"</code>
              example: xyz.streamlock.net/vod/mp4:Movie.mov
            target_delivery_protocol:
              type: string
              description: >-
                The type of stream being delivered from Wowza Video. The default
                and only valid value is **hls-https**.


                **Example:** <code>"target_delivery_protocol":
                "hls-https"</code>
              example: hls-https
              enum:
                - hls-https
            use_stream_source:
              type: boolean
              description: >-
                If **true**, uses a stream source to deliver the stream to Wowza
                Video. The default, **false**, pushes directly to Wowza Video.


                **Example:** <code>"use_stream_source": false</code>
              example: false
            username:
              type: string
              description: >-
                A user name for authenticating an RTMP or RTSP push connection.
                Can contain only uppercase and lowercase letters; numbers; and
                the period (.), underscore (_), and hyphen (-) characters. No
                other special characters can be used.


                **Example:** <code>"username": "client2"</code>
              example: client2
            vod_stream:
              type: boolean
              description: >-
                If **true**, creates a VOD stream after the live stream ends.
                The default is **false**.VOD streams require a Fastly stream
                target with HLS as a delivery protocol.

                > **Note**: If **save_asset** is **true**, that field overrides
                a true **vod_stream** value and the asset is saved in Asset
                Management.


                **Example:** <code>"vod_stream": true</code>
              example: true
            watermark:
              type: boolean
              description: >-
                Embeds an image into the transcoded stream for copyright
                protection. Specify **true** to embed a watermark image.


                **Example:** <code>"watermark": true</code>
              example: ''
            watermark_height:
              type: integer
              description: >-
                The height, in pixels, of the watermark image. If blank, Wowza
                Video uses the original image height.


                **Example:** <code>"watermark_height": 80</code>
              example: ''
              format: int32
            watermark_image:
              type: string
              description: >-
                A Base64-encoded string representation of a GIF, JPEG, or PNG
                image that is embedded in all bitrate renditions of the stream.
                Watermark image files must be 2.5 MB or smaller.


                **Example:** <code>"watermark_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>
              example: ''
            watermark_opacity:
              type: integer
              description: >-
                The opacity, or percentage of transparency, of the watermark.
                **0** is fully transparent; **100** is fully opaque.


                **Example:** <code>"watermark_opacity": 75</code>
              example: ''
              enum:
                - 0
                - 1
                - 2
                - 3
                - 4
                - 5
                - 6
                - 7
                - 8
                - 9
                - 10
                - 11
                - 12
                - 13
                - 14
                - 15
                - 16
                - 17
                - 18
                - 19
                - 20
                - 21
                - 22
                - 23
                - 24
                - 25
                - 26
                - 27
                - 28
                - 29
                - 30
                - 31
                - 32
                - 33
                - 34
                - 35
                - 36
                - 37
                - 38
                - 39
                - 40
                - 41
                - 42
                - 43
                - 44
                - 45
                - 46
                - 47
                - 48
                - 49
                - 50
                - 51
                - 52
                - 53
                - 54
                - 55
                - 56
                - 57
                - 58
                - 59
                - 60
                - 61
                - 62
                - 63
                - 64
                - 65
                - 66
                - 67
                - 68
                - 69
                - 70
                - 71
                - 72
                - 73
                - 74
                - 75
                - 76
                - 77
                - 78
                - 79
                - 80
                - 81
                - 82
                - 83
                - 84
                - 85
                - 86
                - 87
                - 88
                - 89
                - 90
                - 91
                - 92
                - 93
                - 94
                - 95
                - 96
                - 97
                - 98
                - 99
                - 100
              format: int32
            watermark_position:
              type: string
              description: >-
                The corner of the video frame in which you want the watermark to
                appear. The default is **top-left**.


                **Example:** <code>"watermark_position": "top-left"</code>
              example: ''
              enum:
                - top-left
                - top-right
                - bottom-left
                - bottom-right
            watermark_width:
              type: integer
              description: >-
                The width, in pixels, of the watermark image. If blank, Wowza
                Video uses the original image width.


                **Example:** <code>"watermark_width": 100</code>
              example: ''
              format: int32
            countdown:
              type: boolean
              description: 'Enables or disables a countdown timer. '
              example: ''
            countdown_at:
              type: string
              description: >-
                The month, day, year, and time of day that the countdown timer
                should stop displaying to the viewer. Specify **YYYY-MM-DD 
                HH:MM:SS**.


                For example, if you set the **countdown_at** for
                **2024-12-15T17:00:00:000Z** and the **countdown_timezone** as 
                **America/New_York**, the viewer would see their current time
                minus the time remaining until the date and time you set. So, if
                there's 5 hours  to go until 1700 NYC time for the viewer, the
                viewer sees **5:00:00** on the player indicating there are 5
                hours left, then the timer counts down from there. The countdown
                starts as soon as the streamer configures it.


                Required when **countdown** is **true**.


                **Example:** <code>"countdown_at": "2024-02-01T00:00:00.000Z"
              example: '2024-02-01T00:00:00.000Z'
              format: date-time
            countdown_timezone:
              type: string
              example: America/New_York
              description: >-
                The time zone the countdown timer runs in.


                Required when **countdown** is **true**.


                <details> <summary>Click to expand for the full list of valid
                values</summary>

                  | Locations |  Wowza Video time_zone value |
                  |---|---|
                  | International Date Line West  | Etc/GMT+12                     |
                  | Midway Island                 | Pacific/Midway                 |
                  | American Samoa                | Pacific/Pago_Pago              |
                  | Hawaii                        | Pacific/Honolulu               |
                  | Alaska                        | America/Juneau                 |
                  | Pacific Time (US & Canada)    | America/Los_Angeles            |
                  | Tijuana                       | America/Tijuana                |
                  | Mountain Time (US & Canada)   | America/Denver                 |
                  | Arizona                       | America/Phoenix                |
                  | Chihuahua                     | America/Chihuahua              |
                  | Mazatlan                      | America/Mazatlan               |
                  | Central Time (US & Canada)    | America/Chicago                |
                  | Saskatchewan                  | America/Regina                 |
                  | Guadalajara                   | America/Mexico_City            |
                  | Mexico City                   | America/Mexico_City            |
                  | Monterrey                     | America/Monterrey              |
                  | Central America               | America/Guatemala              |
                  | Eastern Time (US & Canada)    | America/New_York               |
                  | Indiana (East)                | America/Indiana/Indianapolis   |
                  | Bogota                        | America/Bogota                 |
                  | Lima                          | America/Lima                   |
                  | Quito                         | America/Lima                   |
                  | Atlantic Time (Canada)        | America/Halifax                |
                  | Caracas                       | America/Caracas                |
                  | La Paz                        | America/La_Paz                 |
                  | Santiago                      | America/Santiago               |
                  | Newfoundland                  | America/St_Johns               |
                  | Brasilia                      | America/Sao_Paulo              |
                  | Buenos Aires                  | America/Argentina/Buenos_Aires |
                  | Montevideo                    | America/Montevideo             |
                  | Georgetown                    | America/Guyana                 |
                  | Puerto Rico                   | America/Puerto_Rico            |
                  | Greenland                     | America/Godthab                |
                  | Mid-Atlantic                  | Atlantic/South_Georgia         |
                  | Azores                        | Atlantic/Azores                |
                  | Cape Verde Is.                | Atlantic/Cape_Verde            |
                  | Dublin                        | Europe/Dublin                  |
                  | Edinburgh                     | Europe/London                  |
                  | Lisbon                        | Europe/Lisbon                  |
                  | London                        | Europe/London                  |
                  | Casablanca                    | Africa/Casablanca              |
                  | Monrovia                      | Africa/Monrovia                |
                  | UTC                           | Etc/UTC                        |
                  | Belgrade                      | Europe/Belgrade                |
                  | Bratislava                    | Europe/Bratislava              |
                  | Budapest                      | Europe/Budapest                |
                  | Ljubljana                     | Europe/Ljubljana               |
                  | Prague                        | Europe/Prague                  |
                  | Sarajevo                      | Europe/Sarajevo                |
                  | Skopje                        | Europe/Skopje                  |
                  | Warsaw                        | Europe/Warsaw                  |
                  | Zagreb                        | Europe/Zagreb                  |
                  | Brussels                      | Europe/Brussels                |
                  | Copenhagen                    | Europe/Copenhagen              |
                  | Madrid                        | Europe/Madrid                  |
                  | Paris                         | Europe/Paris                   |
                  | Amsterdam                     | Europe/Amsterdam               |
                  | Berlin                        | Europe/Berlin                  |
                  | Bern                          | Europe/Zurich                  |
                  | Zurich                        | Europe/Zurich                  |
                  | Rome                          | Europe/Rome                    |
                  | Stockholm                     | Europe/Stockholm               |
                  | Vienna                        | Europe/Vienna                  |
                  | West Central Africa           | Africa/Algiers                 |
                  | Bucharest                     | Europe/Bucharest               |
                  | Cairo                         | Africa/Cairo                   |
                  | Helsinki                      | Europe/Helsinki                |
                  | Kyiv                          | Europe/Kiev                    |
                  | Riga                          | Europe/Riga                    |
                  | Sofia                         | Europe/Sofia                   |
                  | Tallinn                       | Europe/Tallinn                 |
                  | Vilnius                       | Europe/Vilnius                 |
                  | Athens                        | Europe/Athens                  |
                  | Istanbul                      | Europe/Istanbul                |
                  | Minsk                         | Europe/Minsk                   |
                  | Jerusalem                     | Asia/Jerusalem                 |
                  | Harare                        | Africa/Harare                  |
                  | Pretoria                      | Africa/Johannesburg            |
                  | Kaliningrad                   | Europe/Kaliningrad             |
                  | Moscow                        | Europe/Moscow                  |
                  | St. Petersburg                | Europe/Moscow                  |
                  | Volgograd                     | Europe/Volgograd               |
                  | Samara                        | Europe/Samara                  |
                  | Kuwait                        | Asia/Kuwait                    |
                  | Riyadh                        | Asia/Riyadh                    |
                  | Nairobi                       | Africa/Nairobi                 |
                  | Baghdad                       | Asia/Baghdad                   |
                  | Tehran                        | Asia/Tehran                    |
                  | Abu Dhabi                     | Asia/Muscat                    |
                  | Muscat                        | Asia/Muscat                    |
                  | Baku                          | Asia/Baku                      |
                  | Tbilisi                       | Asia/Tbilisi                   |
                  | Yerevan                       | Asia/Yerevan                   |
                  | Kabul                         | Asia/Kabul                     |
                  | Ekaterinburg                  | Asia/Yekaterinburg             |
                  | Islamabad                     | Asia/Karachi                   |
                  | Karachi                       | Asia/Karachi                   |
                  | Tashkent                      | Asia/Tashkent                  |
                  | Chennai                       | Asia/Kolkata                   |
                  | Kolkata                       | Asia/Kolkata                   |
                  | Mumbai                        | Asia/Kolkata                   |
                  | New Delhi                     | Asia/Kolkata                   |
                  | Kathmandu                     | Asia/Kathmandu                 |
                  | Astana                        | Asia/Dhaka                     |
                  | Dhaka                         | Asia/Dhaka                     |
                  | Sri Jayawardenepura           | Asia/Colombo                   |
                  | Almaty                        | Asia/Almaty                    |
                  | Novosibirsk                   | Asia/Novosibirsk               |
                  | Rangoon                       | Asia/Rangoon                   |
                  | Bangkok                       | Asia/Bangkok                   |
                  | Hanoi                         | Asia/Bangkok                   |
                  | Jakarta                       | Asia/Jakarta                   |
                  | Krasnoyarsk                   | Asia/Krasnoyarsk               |
                  | Beijing                       | Asia/Shanghai                  |
                  | Chongqing                     | Asia/Chongqing                 |
                  | Hong Kong                     | Asia/Hong_Kong                 |
                  | Urumqi                        | Asia/Urumqi                    |
                  | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
                  | Singapore                     | Asia/Singapore                 |
                  | Taipei                        | Asia/Taipei                    |
                  | Perth                         | Australia/Perth                |
                  | Irkutsk                       | Asia/Irkutsk                   |
                  | Ulaanbaatar                   | Asia/Ulaanbaatar               |
                  | Seoul                         | Asia/Seoul                     |
                  | Osaka                         | Asia/Tokyo                     |
                  | Sapporo                       | Asia/Tokyo                     |
                  | Tokyo                         | Asia/Tokyo                     |
                  | Yakutsk                       | Asia/Yakutsk                   |
                  | Darwin                        | Australia/Darwin               |
                  | Adelaide                      | Australia/Adelaide             |
                  | Canberra                      | Australia/Melbourne            |
                  | Melbourne                     | Australia/Melbourne            |
                  | Sydney                        | Australia/Sydney               |
                  | Brisbane                      | Australia/Brisbane             |
                  | Hobart                        | Australia/Hobart               |
                  | Vladivostok                   | Asia/Vladivostok               |
                  | Guam                          | Pacific/Guam                   |
                  | Port Moresby                  | Pacific/Port_Moresby           |
                  | Magadan                       | Asia/Magadan                   |
                  | Srednekolymsk                 | Asia/Srednekolymsk             |
                  | Solomon Is.                   | Pacific/Guadalcanal            |
                  | New Caledonia                 | Pacific/Noumea                 |
                  | Fiji                          | Pacific/Fiji                   |
                  | Kamchatka                     | Asia/Kamchatka                 |
                  | Marshall Is.                  | Pacific/Majuro                 |
                  | Auckland                      | Pacific/Auckland               |
                  | Wellington                    | Pacific/Auckland               |
                  | Nuku'alofa                    | Pacific/Tongatapu              |
                  | Tokelau Is.                   | Pacific/Fakaofo                |
                  | Chatham Is.                   | Pacific/Chatham                |
                  | Samoa                         | Pacific/Apia                   |

                </details>


                **Default:** `Etc/UTC`


                **Example:** `America/New_York`
      example:
        live_stream:
          name: My Updated Live Stream
          description: This is my first live stream.
          recording: true
    schedule:
      type: object
      description: ''
      properties:
        action_type:
          type: string
          description: >-
            The type of action that the schedule should trigger on the
            transcoder. The default is **start**.
          example: start_stop
          enum:
            - start
            - stop
            - start_stop
        created_at:
          type: string
          description: The date and time that the schedule was created.
          example: '2020-01-29T17:16:21.995Z'
          format: date-time
        end_repeat:
          type: string
          description: >-
            The month, day, and year that a recurring schedule should stop
            running. Specify **YYYY-MM-DD**.
          example: '2020-02-29T00:00:00.000Z'
          format: date
        id:
          type: string
          description: The unique alphanumeric string that identifies the schedule.
          example: vhB0jSlB
        name:
          type: string
          description: A descriptive name for the schedule. Maximum 255 characters.
          example: Scheduled start for my camera
        recurrence_data:
          type: string
          description: The day or days of the week that a recurring schedule should run.
          example: monday,tuesday,wednesday,thursday,friday
          enum:
            - sunday
            - monday
            - tuesday
            - wednesday
            - thursday
            - friday
            - saturday
        recurrence_type:
          type: string
          description: >-
            A schedule can run one time only (**once**) or repeat (**recur**)
            until a specified *end_repeat* date. The default is **once**.
          example: recur
          enum:
            - once
            - recur
        start_repeat:
          type: string
          description: >-
            The month, day, and year that the recurring schedule should go into
            effect. Specify **YYYY-MM-DD**.
          example: '2020-02-01T00:00:00.000Z'
          format: date
        start_transcoder:
          type: string
          description: >-
            The month, day, year, and time of day that the *action_type*
            **start** should occur. Specify **YYYY-MM-DD HH:MM:SS** where **HH**
            is a 24-hour clock in UTC.
          example: '2020-02-01T00:00:00.000Z'
          format: date-time
        state:
          type: string
          description: >-
            A schedule must be **enabled** to run. Specify **enabled** to run
            the schedule or **disabled** to turn off the schedule so that it
            doesn't run.
          example: enabled
          enum:
            - enabled
            - disabled
            - expired
        stop_transcoder:
          type: string
          description: >-
            The month, day, year, and time of day that the *action_type*
            **stop** should occur. Specify **YYYY-MM-DD HH:MM:SS** where **HH**
            is a 24-hour clock in UTC.
          example: '2020-02-29T23:59:59.999Z'
          format: date-time
        time_zone:
          type: string
          description: The time zone the schedule runs in.
        transcoder_id:
          type: string
          description: >-
            The unique alphanumeric string that identifies the transcoder being
            scheduled.
          example: P0NrTP7m
        transcoder_name:
          type: string
          description: The name of the transcoder being scheduled.
          example: My Camera
        updated_at:
          type: string
          description: The date and time that the schedule was updated.
          example: '2020-01-30T16:44:37.995Z'
          format: date-time
      example:
        id: 28bwb5WT
        state: disabled
        name: Scheduled recurring start for my camera
        time_zone: America/New_York
        transcoder_id: VGB21JFJ
        transcoder_name: My Camera
        recurrence_type: recur
        recurrence_data: monday,tuesday,wednesday,thursday,friday
        action_type: start_stop
        start_transcoder: '2020-02-01T00:00:00.000Z'
        stop_transcoder: '2020-02-29T23:59:59.999Z'
        start_repeat: '2020-02-01T00:00:00.000Z'
        end_repeat: '2020-02-29T00:00:00.000Z'
        created_at: '2020-01-29T17:16:21.995Z'
        updated_at: '2020-01-31T07:00:48.995Z'
    schedules:
      type: object
      description: ''
      required:
        - schedules
      properties:
        schedules:
          type: array
          items:
            $ref: '#/components/schemas/schedule'
      example:
        schedules:
          - id: 28bwb5WT
            state: disabled
            name: Scheduled recurring start for my camera
            transcoder_id: VGB21JFJ
            transcoder_name: My Camera
            recurrence_type: recur
            recurrence_data: monday,tuesday,wednesday,thursday,friday
            action_type: start_stop
            start_transcoder: '2020-02-01T00:00:00.000Z'
            stop_transcoder: '2020-02-29T23:59:59.999Z'
            start_repeat: '2020-02-01T00:00:00.000Z'
            end_repeat: '2020-02-29T00:00:00.000Z'
            created_at: '2020-01-29T17:16:21.995Z'
            updated_at: '2020-01-31T14:58:43.995Z'
          - id: 4RCWgfS5
            state: enabled
            name: Scheduled stop for my live event
            transcoder_id: Qjl5J38Z
            transcoder_name: Awesome Live Event
            recurrence_type: once
            action_type: stop
            start_transcoder: '2020-02-01T00:00:00.000Z'
            stop_transcoder: '2020-02-29T23:59:59.999Z'
            created_at: '2020-01-29T17:16:21.995Z'
            updated_at: '2020-01-31T08:25:45.995Z'
    schedule_create_input:
      type: object
      description: ''
      required:
        - schedule
      properties:
        schedule:
          type: object
          title: schedule
          description: ''
          required:
            - name
            - transcoder_id
            - action_type
            - recurrence_type
          properties:
            action_type:
              type: string
              description: >-
                The type of action that the schedule should trigger on the
                transcoder. The default is **start**.
              example: start_stop
              enum:
                - start
                - stop
                - start_stop
            name:
              type: string
              description: A descriptive name for the schedule. Maximum 255 characters.
              example: Scheduled start for my camera
            recurrence_type:
              type: string
              description: >-
                A schedule can run one time only (**once**) or repeat
                (**recur**) until a specified *end_repeat* date. The default is
                **once**.
              example: recur
              enum:
                - once
                - recur
            time_zone:
              type: string
              example: America/New_York
              description: >-
                The time zone the schedule runs in.

                <details> <summary>Click to expand for the full list of valid
                values</summary>

                  | Locations |  Wowza Video time_zone value |
                  |---|---|
                  | International Date Line West  | Etc/GMT+12                     |
                  | Midway Island                 | Pacific/Midway                 |
                  | American Samoa                | Pacific/Pago_Pago              |
                  | Hawaii                        | Pacific/Honolulu               |
                  | Alaska                        | America/Juneau                 |
                  | Pacific Time (US & Canada)    | America/Los_Angeles            |
                  | Tijuana                       | America/Tijuana                |
                  | Mountain Time (US & Canada)   | America/Denver                 |
                  | Arizona                       | America/Phoenix                |
                  | Chihuahua                     | America/Chihuahua              |
                  | Mazatlan                      | America/Mazatlan               |
                  | Central Time (US & Canada)    | America/Chicago                |
                  | Saskatchewan                  | America/Regina                 |
                  | Guadalajara                   | America/Mexico_City            |
                  | Mexico City                   | America/Mexico_City            |
                  | Monterrey                     | America/Monterrey              |
                  | Central America               | America/Guatemala              |
                  | Eastern Time (US & Canada)    | America/New_York               |
                  | Indiana (East)                | America/Indiana/Indianapolis   |
                  | Bogota                        | America/Bogota                 |
                  | Lima                          | America/Lima                   |
                  | Quito                         | America/Lima                   |
                  | Atlantic Time (Canada)        | America/Halifax                |
                  | Caracas                       | America/Caracas                |
                  | La Paz                        | America/La_Paz                 |
                  | Santiago                      | America/Santiago               |
                  | Newfoundland                  | America/St_Johns               |
                  | Brasilia                      | America/Sao_Paulo              |
                  | Buenos Aires                  | America/Argentina/Buenos_Aires |
                  | Montevideo                    | America/Montevideo             |
                  | Georgetown                    | America/Guyana                 |
                  | Puerto Rico                   | America/Puerto_Rico            |
                  | Greenland                     | America/Godthab                |
                  | Mid-Atlantic                  | Atlantic/South_Georgia         |
                  | Azores                        | Atlantic/Azores                |
                  | Cape Verde Is.                | Atlantic/Cape_Verde            |
                  | Dublin                        | Europe/Dublin                  |
                  | Edinburgh                     | Europe/London                  |
                  | Lisbon                        | Europe/Lisbon                  |
                  | London                        | Europe/London                  |
                  | Casablanca                    | Africa/Casablanca              |
                  | Monrovia                      | Africa/Monrovia                |
                  | UTC                           | Etc/UTC                        |
                  | Belgrade                      | Europe/Belgrade                |
                  | Bratislava                    | Europe/Bratislava              |
                  | Budapest                      | Europe/Budapest                |
                  | Ljubljana                     | Europe/Ljubljana               |
                  | Prague                        | Europe/Prague                  |
                  | Sarajevo                      | Europe/Sarajevo                |
                  | Skopje                        | Europe/Skopje                  |
                  | Warsaw                        | Europe/Warsaw                  |
                  | Zagreb                        | Europe/Zagreb                  |
                  | Brussels                      | Europe/Brussels                |
                  | Copenhagen                    | Europe/Copenhagen              |
                  | Madrid                        | Europe/Madrid                  |
                  | Paris                         | Europe/Paris                   |
                  | Amsterdam                     | Europe/Amsterdam               |
                  | Berlin                        | Europe/Berlin                  |
                  | Bern                          | Europe/Zurich                  |
                  | Zurich                        | Europe/Zurich                  |
                  | Rome                          | Europe/Rome                    |
                  | Stockholm                     | Europe/Stockholm               |
                  | Vienna                        | Europe/Vienna                  |
                  | West Central Africa           | Africa/Algiers                 |
                  | Bucharest                     | Europe/Bucharest               |
                  | Cairo                         | Africa/Cairo                   |
                  | Helsinki                      | Europe/Helsinki                |
                  | Kyiv                          | Europe/Kiev                    |
                  | Riga                          | Europe/Riga                    |
                  | Sofia                         | Europe/Sofia                   |
                  | Tallinn                       | Europe/Tallinn                 |
                  | Vilnius                       | Europe/Vilnius                 |
                  | Athens                        | Europe/Athens                  |
                  | Istanbul                      | Europe/Istanbul                |
                  | Minsk                         | Europe/Minsk                   |
                  | Jerusalem                     | Asia/Jerusalem                 |
                  | Harare                        | Africa/Harare                  |
                  | Pretoria                      | Africa/Johannesburg            |
                  | Kaliningrad                   | Europe/Kaliningrad             |
                  | Moscow                        | Europe/Moscow                  |
                  | St. Petersburg                | Europe/Moscow                  |
                  | Volgograd                     | Europe/Volgograd               |
                  | Samara                        | Europe/Samara                  |
                  | Kuwait                        | Asia/Kuwait                    |
                  | Riyadh                        | Asia/Riyadh                    |
                  | Nairobi                       | Africa/Nairobi                 |
                  | Baghdad                       | Asia/Baghdad                   |
                  | Tehran                        | Asia/Tehran                    |
                  | Abu Dhabi                     | Asia/Muscat                    |
                  | Muscat                        | Asia/Muscat                    |
                  | Baku                          | Asia/Baku                      |
                  | Tbilisi                       | Asia/Tbilisi                   |
                  | Yerevan                       | Asia/Yerevan                   |
                  | Kabul                         | Asia/Kabul                     |
                  | Ekaterinburg                  | Asia/Yekaterinburg             |
                  | Islamabad                     | Asia/Karachi                   |
                  | Karachi                       | Asia/Karachi                   |
                  | Tashkent                      | Asia/Tashkent                  |
                  | Chennai                       | Asia/Kolkata                   |
                  | Kolkata                       | Asia/Kolkata                   |
                  | Mumbai                        | Asia/Kolkata                   |
                  | New Delhi                     | Asia/Kolkata                   |
                  | Kathmandu                     | Asia/Kathmandu                 |
                  | Astana                        | Asia/Dhaka                     |
                  | Dhaka                         | Asia/Dhaka                     |
                  | Sri Jayawardenepura           | Asia/Colombo                   |
                  | Almaty                        | Asia/Almaty                    |
                  | Novosibirsk                   | Asia/Novosibirsk               |
                  | Rangoon                       | Asia/Rangoon                   |
                  | Bangkok                       | Asia/Bangkok                   |
                  | Hanoi                         | Asia/Bangkok                   |
                  | Jakarta                       | Asia/Jakarta                   |
                  | Krasnoyarsk                   | Asia/Krasnoyarsk               |
                  | Beijing                       | Asia/Shanghai                  |
                  | Chongqing                     | Asia/Chongqing                 |
                  | Hong Kong                     | Asia/Hong_Kong                 |
                  | Urumqi                        | Asia/Urumqi                    |
                  | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
                  | Singapore                     | Asia/Singapore                 |
                  | Taipei                        | Asia/Taipei                    |
                  | Perth                         | Australia/Perth                |
                  | Irkutsk                       | Asia/Irkutsk                   |
                  | Ulaanbaatar                   | Asia/Ulaanbaatar               |
                  | Seoul                         | Asia/Seoul                     |
                  | Osaka                         | Asia/Tokyo                     |
                  | Sapporo                       | Asia/Tokyo                     |
                  | Tokyo                         | Asia/Tokyo                     |
                  | Yakutsk                       | Asia/Yakutsk                   |
                  | Darwin                        | Australia/Darwin               |
                  | Adelaide                      | Australia/Adelaide             |
                  | Canberra                      | Australia/Melbourne            |
                  | Melbourne                     | Australia/Melbourne            |
                  | Sydney                        | Australia/Sydney               |
                  | Brisbane                      | Australia/Brisbane             |
                  | Hobart                        | Australia/Hobart               |
                  | Vladivostok                   | Asia/Vladivostok               |
                  | Guam                          | Pacific/Guam                   |
                  | Port Moresby                  | Pacific/Port_Moresby           |
                  | Magadan                       | Asia/Magadan                   |
                  | Srednekolymsk                 | Asia/Srednekolymsk             |
                  | Solomon Is.                   | Pacific/Guadalcanal            |
                  | New Caledonia                 | Pacific/Noumea                 |
                  | Fiji                          | Pacific/Fiji                   |
                  | Kamchatka                     | Asia/Kamchatka                 |
                  | Marshall Is.                  | Pacific/Majuro                 |
                  | Auckland                      | Pacific/Auckland               |
                  | Wellington                    | Pacific/Auckland               |
                  | Nuku'alofa                    | Pacific/Tongatapu              |
                  | Tokelau Is.                   | Pacific/Fakaofo                |
                  | Chatham Is.                   | Pacific/Chatham                |
                  | Samoa                         | Pacific/Apia                   |

                </details>


                **Default:** `Etc/UTC`


                **Example:** `America/New_York`
            transcoder_id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the transcoder
                being scheduled.
              example: km1FSSVL
            end_repeat:
              type: string
              description: >-
                The month, day, and year that a recurring schedule should stop
                running. Specify **YYYY-MM-DD**.


                **Example:** <code>"end_repeat":
                "2020-02-29T00:00:00.000Z"</code>
              example: '2020-02-29T00:00:00.000Z'
              format: date
            recurrence_data:
              type: string
              description: >-
                The day or days of the week that a recurring schedule should
                run.


                **Example:** <code>"recurrence_data":
                "monday,tuesday,wednesday,thursday,friday"</code>
              example: monday,tuesday,wednesday,thursday,friday
              enum:
                - sunday
                - monday
                - tuesday
                - wednesday
                - thursday
                - friday
                - saturday
            start_repeat:
              type: string
              description: >-
                The month, day, and year that the recurring schedule should go
                into effect. Specify **YYYY-MM-DD**.


                **Example:** <code>"start_repeat":
                "2020-02-01T00:00:00.000Z"</code>
              example: '2020-02-01T00:00:00.000Z'
              format: date
            start_transcoder:
              type: string
              description: >-
                The month, day, year, and time of day that the *action_type*
                **start** should occur. Specify **YYYY-MM-DD HH:MM:SS** where
                **HH** is a 24-hour clock in UTC.


                Required when **action_type** is **start** or **start_stop**.


                **Example:** <code>"start_transcoder":
                "2020-02-01T00:00:00.000Z"</code>
              example: '2020-02-01T00:00:00.000Z'
              format: date-time
            stop_transcoder:
              type: string
              description: >-
                The month, day, year, and time of day that the *action_type*
                **stop** should occur. Specify **YYYY-MM-DD HH:MM:SS** where
                **HH** is a 24-hour clock in UTC.


                Required when **action_type** is **stop** or **start_stop**.


                **Example:** <code>"start_transcoder":
                "2020-02-29T23:59:59.999Z"</code>
              example: '2020-02-29T23:59:59.999Z'
              format: date-time
    schedule_update_input:
      type: object
      description: ''
      required:
        - schedule
      properties:
        schedule:
          type: object
          title: schedule
          description: ''
          properties:
            action_type:
              type: string
              description: >-
                The type of action that the schedule should trigger on the
                transcoder. The default is **start**.


                **Example:** <code>"action_type": "stop"</code>
              example: start_stop
              enum:
                - start
                - stop
                - start_stop
            name:
              type: string
              description: |-
                A descriptive name for the schedule. Maximum 255 characters.

                **Example:** <code>"name": "My Updated Schedule"</code>
              example: Scheduled start for my camera
            end_repeat:
              type: string
              description: >-
                The month, day, and year that a recurring schedule should stop
                running. Specify **YYYY-MM-DD**.


                **Example:** <code>"end_repeat":
                "2020-02-29T00:00:00.000Z"</code>
              example: '2020-02-29T00:00:00.000Z'
              format: date
            recurrence_data:
              type: string
              description: >-
                The day or days of the week that a recurring schedule should
                run.


                **Example:** <code>"recurrence_data":
                "monday,tuesday,wednesday,thursday,friday"</code>
              example: monday,tuesday,wednesday,thursday,friday
              enum:
                - sunday
                - monday
                - tuesday
                - wednesday
                - thursday
                - friday
                - saturday
            start_repeat:
              type: string
              description: >-
                The month, day, and year that the recurring schedule should go
                into effect. Specify **YYYY-MM-DD**.


                **Example:** <code>"start_repeat":
                "2020-02-01T00:00:00.000Z"</code>
              example: '2020-02-01T00:00:00.000Z'
              format: date
            start_transcoder:
              type: string
              description: >-
                The month, day, year, and time of day that the *action_type*
                **start** should occur. Specify **YYYY-MM-DD HH:MM:SS** where
                **HH** is a 24-hour clock in UTC.


                **Example:** <code>"start_transcoder":
                "2020-02-01T00:00:00.000Z"</code>
              example: '2020-02-01T00:00:00.000Z'
              format: date-time
            stop_transcoder:
              type: string
              description: >-
                The month, day, year, and time of day that the *action_type*
                **stop** should occur. Specify **YYYY-MM-DD HH:MM:SS** where
                **HH** is a 24-hour clock in UTC.


                **Example:** <code>"start_transcoder":
                "2020-02-29T23:59:59.999Z"</code>
              example: '2020-02-29T23:59:59.999Z'
              format: date-time
            time_zone:
              type: string
              description: >-
                The time zone the schedule runs in.

                <details> <summary>Click to expand for the full list of valid
                values</summary>

                  | Locations |  Wowza Video time_zone value |
                  |---|---|
                  | International Date Line West  | Etc/GMT+12                     |
                  | Midway Island                 | Pacific/Midway                 |
                  | American Samoa                | Pacific/Pago_Pago              |
                  | Hawaii                        | Pacific/Honolulu               |
                  | Alaska                        | America/Juneau                 |
                  | Pacific Time (US & Canada)    | America/Los_Angeles            |
                  | Tijuana                       | America/Tijuana                |
                  | Mountain Time (US & Canada)   | America/Denver                 |
                  | Arizona                       | America/Phoenix                |
                  | Chihuahua                     | America/Chihuahua              |
                  | Mazatlan                      | America/Mazatlan               |
                  | Central Time (US & Canada)    | America/Chicago                |
                  | Saskatchewan                  | America/Regina                 |
                  | Guadalajara                   | America/Mexico_City            |
                  | Mexico City                   | America/Mexico_City            |
                  | Monterrey                     | America/Monterrey              |
                  | Central America               | America/Guatemala              |
                  | Eastern Time (US & Canada)    | America/New_York               |
                  | Indiana (East)                | America/Indiana/Indianapolis   |
                  | Bogota                        | America/Bogota                 |
                  | Lima                          | America/Lima                   |
                  | Quito                         | America/Lima                   |
                  | Atlantic Time (Canada)        | America/Halifax                |
                  | Caracas                       | America/Caracas                |
                  | La Paz                        | America/La_Paz                 |
                  | Santiago                      | America/Santiago               |
                  | Newfoundland                  | America/St_Johns               |
                  | Brasilia                      | America/Sao_Paulo              |
                  | Buenos Aires                  | America/Argentina/Buenos_Aires |
                  | Montevideo                    | America/Montevideo             |
                  | Georgetown                    | America/Guyana                 |
                  | Puerto Rico                   | America/Puerto_Rico            |
                  | Greenland                     | America/Godthab                |
                  | Mid-Atlantic                  | Atlantic/South_Georgia         |
                  | Azores                        | Atlantic/Azores                |
                  | Cape Verde Is.                | Atlantic/Cape_Verde            |
                  | Dublin                        | Europe/Dublin                  |
                  | Edinburgh                     | Europe/London                  |
                  | Lisbon                        | Europe/Lisbon                  |
                  | London                        | Europe/London                  |
                  | Casablanca                    | Africa/Casablanca              |
                  | Monrovia                      | Africa/Monrovia                |
                  | UTC                           | Etc/UTC                        |
                  | Belgrade                      | Europe/Belgrade                |
                  | Bratislava                    | Europe/Bratislava              |
                  | Budapest                      | Europe/Budapest                |
                  | Ljubljana                     | Europe/Ljubljana               |
                  | Prague                        | Europe/Prague                  |
                  | Sarajevo                      | Europe/Sarajevo                |
                  | Skopje                        | Europe/Skopje                  |
                  | Warsaw                        | Europe/Warsaw                  |
                  | Zagreb                        | Europe/Zagreb                  |
                  | Brussels                      | Europe/Brussels                |
                  | Copenhagen                    | Europe/Copenhagen              |
                  | Madrid                        | Europe/Madrid                  |
                  | Paris                         | Europe/Paris                   |
                  | Amsterdam                     | Europe/Amsterdam               |
                  | Berlin                        | Europe/Berlin                  |
                  | Bern                          | Europe/Zurich                  |
                  | Zurich                        | Europe/Zurich                  |
                  | Rome                          | Europe/Rome                    |
                  | Stockholm                     | Europe/Stockholm               |
                  | Vienna                        | Europe/Vienna                  |
                  | West Central Africa           | Africa/Algiers                 |
                  | Bucharest                     | Europe/Bucharest               |
                  | Cairo                         | Africa/Cairo                   |
                  | Helsinki                      | Europe/Helsinki                |
                  | Kyiv                          | Europe/Kiev                    |
                  | Riga                          | Europe/Riga                    |
                  | Sofia                         | Europe/Sofia                   |
                  | Tallinn                       | Europe/Tallinn                 |
                  | Vilnius                       | Europe/Vilnius                 |
                  | Athens                        | Europe/Athens                  |
                  | Istanbul                      | Europe/Istanbul                |
                  | Minsk                         | Europe/Minsk                   |
                  | Jerusalem                     | Asia/Jerusalem                 |
                  | Harare                        | Africa/Harare                  |
                  | Pretoria                      | Africa/Johannesburg            |
                  | Kaliningrad                   | Europe/Kaliningrad             |
                  | Moscow                        | Europe/Moscow                  |
                  | St. Petersburg                | Europe/Moscow                  |
                  | Volgograd                     | Europe/Volgograd               |
                  | Samara                        | Europe/Samara                  |
                  | Kuwait                        | Asia/Kuwait                    |
                  | Riyadh                        | Asia/Riyadh                    |
                  | Nairobi                       | Africa/Nairobi                 |
                  | Baghdad                       | Asia/Baghdad                   |
                  | Tehran                        | Asia/Tehran                    |
                  | Abu Dhabi                     | Asia/Muscat                    |
                  | Muscat                        | Asia/Muscat                    |
                  | Baku                          | Asia/Baku                      |
                  | Tbilisi                       | Asia/Tbilisi                   |
                  | Yerevan                       | Asia/Yerevan                   |
                  | Kabul                         | Asia/Kabul                     |
                  | Ekaterinburg                  | Asia/Yekaterinburg             |
                  | Islamabad                     | Asia/Karachi                   |
                  | Karachi                       | Asia/Karachi                   |
                  | Tashkent                      | Asia/Tashkent                  |
                  | Chennai                       | Asia/Kolkata                   |
                  | Kolkata                       | Asia/Kolkata                   |
                  | Mumbai                        | Asia/Kolkata                   |
                  | New Delhi                     | Asia/Kolkata                   |
                  | Kathmandu                     | Asia/Kathmandu                 |
                  | Astana                        | Asia/Dhaka                     |
                  | Dhaka                         | Asia/Dhaka                     |
                  | Sri Jayawardenepura           | Asia/Colombo                   |
                  | Almaty                        | Asia/Almaty                    |
                  | Novosibirsk                   | Asia/Novosibirsk               |
                  | Rangoon                       | Asia/Rangoon                   |
                  | Bangkok                       | Asia/Bangkok                   |
                  | Hanoi                         | Asia/Bangkok                   |
                  | Jakarta                       | Asia/Jakarta                   |
                  | Krasnoyarsk                   | Asia/Krasnoyarsk               |
                  | Beijing                       | Asia/Shanghai                  |
                  | Chongqing                     | Asia/Chongqing                 |
                  | Hong Kong                     | Asia/Hong_Kong                 |
                  | Urumqi                        | Asia/Urumqi                    |
                  | Kuala Lumpur                  | Asia/Kuala_Lumpur              |
                  | Singapore                     | Asia/Singapore                 |
                  | Taipei                        | Asia/Taipei                    |
                  | Perth                         | Australia/Perth                |
                  | Irkutsk                       | Asia/Irkutsk                   |
                  | Ulaanbaatar                   | Asia/Ulaanbaatar               |
                  | Seoul                         | Asia/Seoul                     |
                  | Osaka                         | Asia/Tokyo                     |
                  | Sapporo                       | Asia/Tokyo                     |
                  | Tokyo                         | Asia/Tokyo                     |
                  | Yakutsk                       | Asia/Yakutsk                   |
                  | Darwin                        | Australia/Darwin               |
                  | Adelaide                      | Australia/Adelaide             |
                  | Canberra                      | Australia/Melbourne            |
                  | Melbourne                     | Australia/Melbourne            |
                  | Sydney                        | Australia/Sydney               |
                  | Brisbane                      | Australia/Brisbane             |
                  | Hobart                        | Australia/Hobart               |
                  | Vladivostok                   | Asia/Vladivostok               |
                  | Guam                          | Pacific/Guam                   |
                  | Port Moresby                  | Pacific/Port_Moresby           |
                  | Magadan                       | Asia/Magadan                   |
                  | Srednekolymsk                 | Asia/Srednekolymsk             |
                  | Solomon Is.                   | Pacific/Guadalcanal            |
                  | New Caledonia                 | Pacific/Noumea                 |
                  | Fiji                          | Pacific/Fiji                   |
                  | Kamchatka                     | Asia/Kamchatka                 |
                  | Marshall Is.                  | Pacific/Majuro                 |
                  | Auckland                      | Pacific/Auckland               |
                  | Wellington                    | Pacific/Auckland               |
                  | Nuku'alofa                    | Pacific/Tongatapu              |
                  | Tokelau Is.                   | Pacific/Fakaofo                |
                  | Chatham Is.                   | Pacific/Chatham                |
                  | Samoa                         | Pacific/Apia                   |

                </details>


                **Default:** `Etc/UTC`


                **Example:** `America/New_York`
              example: America/New_York
    index_stream_source:
      type: object
      description: ''
      title: stream_sources
      properties:
        created_at:
          type: string
          description: The date and time that the stream source was created.
          example: ''
          format: date-time
        id:
          type: string
          description: The unique alphanumeric string that identifies the stream source.
          example: ''
        name:
          type: string
          description: A descriptive name for the stream source. Maximum 255 characters.
          example: ''
        type:
          type: string
          description: >-
            A **wowza** stream source enables automatic transcoder start, stop,
            and broadcast location detection.
          example: ''
          enum:
            - wowza
        updated_at:
          type: string
          description: The date and time that the stream source was updated.
          example: ''
          format: date-time
    stream_sources:
      type: object
      description: ''
      required:
        - stream_sources
      properties:
        stream_sources:
          type: array
          items:
            $ref: '#/components/schemas/index_stream_source'
      example:
        stream_sources:
          - id: cJYndjJt
            name: My region-based Stream Source
            type: wowza
            created_at: '2020-01-29T17:16:22.000Z'
            updated_at: '2020-01-31T02:37:48.000Z'
          - id: pvVWPLZC
            name: My IP address based Stream Source
            type: wowza
            created_at: '2020-01-28T17:16:22.000Z'
            updated_at: '2020-01-30T14:13:07.000Z'
    wowza_stream_source_create_input:
      type: object
      description: ''
      required:
        - stream_source_wowza
      properties:
        stream_source_wowza:
          type: object
          title: stream_source_wowza
          description: ''
          example:
            name: My Wowza Stream Source
          required:
            - name
          properties:
            name:
              type: string
              description: >-
                A descriptive name for the Wowza stream source. Maximum 255
                characters.
              example: My region-based Akamai Stream Source
    stream_source_wowza_create:
      type: object
      title: stream_source_wowza
      description: ''
      properties:
        created_at:
          type: string
          description: The date and time that the Wowza stream source was created.
          example: ''
          format: date-time
        id:
          type: string
          description: >-
            The unique alphanumeric string that identifies the Wowza stream
            source.
          example: ''
        name:
          type: string
          description: >-
            A descriptive name for the Wowza stream source. Maximum 255
            characters.
          example: ''
        primary_url:
          type: string
          description: The origin URL where you send your source stream.
          example: ''
        state:
          type: string
          description: The current state of the Wowza stream source.
          example: ''
          enum:
            - started
            - stopped
            - error
        stream_name:
          type: string
          description: >-
            The name of the stream that you can use to configure the source
            encoder to connect to the Wowza stream source.
          example: ''
        updated_at:
          type: string
          description: The date and time that the Wowza stream source was updated.
          example: ''
          format: date-time
      example:
        created_at: '2020-01-29T17:16:22.001Z'
        id: brcndjJt
        name: My Wowza Stream Source
        primary_url: rtmp://origin.cdn.wowza.com:1935/live
        state: stopped
        stream_name: 0I3abc1FPZ2P3Qxdfz3YwKtZdDqu6102
        updated_at: '2020-01-31T07:32:43.001Z'
    stream_source_wowza:
      type: object
      description: ''
      title: stream_source_wowza
      properties:
        created_at:
          type: string
          description: The date and time that the Wowza stream source was created.
          example: ''
          format: date-time
        id:
          type: string
          description: >-
            The unique alphanumeric string that identifies the Wowza stream
            source.
          example: ''
        name:
          type: string
          description: >-
            A descriptive name for the Wowza stream source. Maximum 255
            characters.
          example: ''
        primary_url:
          type: string
          description: The origin URL where you send your source stream.
          example: ''
        state:
          type: string
          description: The current state of the Wowza stream source.
          example: ''
          enum:
            - started
            - stopped
            - error
        stream_name:
          type: string
          description: >-
            The name of the stream that you can use to configure the source
            encoder to connect to the Wowza stream source.
          example: ''
        transcoders:
          type: array
          description: The transcoders associated with the Wowza stream source.
          items:
            type: object
            title: transcoders
            properties:
              id:
                type: string
                description: The unique alphanumeric string that identifies the transcoder.
                example: ''
              name:
                type: string
                description: A descriptive name for the transcoder. Maximum 255 characters.
                example: dcxq5q6c
              type:
                type: string
                description: >-
                  The type of transcoder associated with the Wowza stream source
                  be it a transcoder associated with a live stream or a
                  standalone transcoder.
                example: ''
                enum:
                  - transcoder
                  - livestream
        updated_at:
          type: string
          description: The date and time that the Wowza stream source was updated.
          example: ''
          format: date-time
      example:
        created_at: '2020-01-29T17:16:22.001Z'
        id: brcndjJt
        name: My Wowza Stream Source
        primary_url: rtmp://origin.cdn.wowza.com:1935/live
        state: stopped
        stream_name: 0I3abc1FPZ2P3Qxdfz3YwKtZdDqu6102
        transcoders:
          - id: dkcr5y9l
            name: my transcoder
            type: LiveStream
        updated_at: '2020-01-31T07:32:43.001Z'
    wowza_stream_source_update_input:
      type: object
      description: ''
      required:
        - stream_source_wowza
      properties:
        stream_source_wowza:
          type: object
          title: stream_source_wowza
          description: ''
          required:
            - name
          properties:
            name:
              type: string
              description: >-
                A descriptive name for the Wowza stream source. Maximum 255
                characters.
              example: My Updated Wowza Stream Source
    wowza_stream_source_patch_response:
      type: object
      title: stream_source_wowza
      description: ''
      properties:
        created_at:
          type: string
          description: The date and time that the Wowza stream source was created.
          example: ''
          format: date-time
        id:
          type: string
          description: >-
            The unique alphanumeric string that identifies the Wowza stream
            source.
          example: ''
        name:
          type: string
          description: >-
            A descriptive name for the Wowza stream source. Maximum 255
            characters.
          example: ''
        primary_url:
          type: string
          description: The origin URL where you send your source stream.
          example: ''
        state:
          type: string
          description: The current state of the Wowza stream source.
          example: ''
          enum:
            - started
            - stopped
            - error
        stream_name:
          type: string
          description: >-
            The name of the stream that you can use to configure the source
            encoder to connect to the Wowza stream source.
          example: ''
        transcoders:
          type: array
          description: The transcoders associated with the Wowza stream source.
          items:
            type: object
            title: transcoders
            properties:
              id:
                type: string
                description: The unique alphanumeric string that identifies the transcoder.
                example: ''
              name:
                type: string
                description: A descriptive name for the transcoder. Maximum 255 characters.
                example: dcxq5q6c
              type:
                type: string
                description: >-
                  The type of transcoder associated with the Wowza stream source
                  be it a transcoder associated with a live stream or a
                  standalone transcoder.
                example: ''
                enum:
                  - transcoder
                  - livestream
        updated_at:
          type: string
          description: The date and time that the Wowza stream source was updated.
          example: ''
          format: date-time
      example:
        created_at: '2020-01-29T17:16:22.001Z'
        id: brcndjJt
        name: My Updated Wowza Stream Source
        primary_url: rtmp://origin.cdn.wowza.com:1935/live
        state: stopped
        stream_name: 0I3abc1FPZ2P3Qxdfz3YwKtZdDqu6102
        transcoders:
          - id: dkcr5y9l
            name: my transcoder
            type: LiveStream
        updated_at: '2020-01-31T14:56:21.001Z'
    index_stream_target:
      type: object
      description: ''
      title: stream_targets
      properties:
        created_at:
          type: string
          description: The date and time that the stream target was created.
          example: ''
          format: date-time
        id:
          type: string
          description: The unique alphanumeric string that identifies the stream target.
          example: ''
        name:
          type: string
          description: A descriptive name for the stream target. Maximum 255 characters.
          example: ''
        state:
          type: string
          description: The state of the stream target.
          example: activated
          enum:
            - activated
            - archived
        type:
          type: string
          description: >-
            **custom** is an external, third-party destination and **wowza_cdn**
            is a Wowza CDN target. 
          example: ''
          enum:
            - custom
            - wowza_cdn
        updated_at:
          type: string
          description: The date and time that the stream target was updated.
          example: ''
          format: date-time
    stream_targets:
      type: object
      description: ''
      required:
        - stream_targets
      properties:
        stream_targets:
          type: array
          items:
            $ref: '#/components/schemas/index_stream_target'
      example:
        stream_targets:
          - created_at: '2020-01-29T17:16:22.007Z'
            id: qvvjyjjk
            name: My RTMP Stream Target
            state: deactivated
            type: wowza
            updated_at: '2020-01-31T02:05:18.007Z'
          - created_at: '2020-01-28T17:16:22.007Z'
            id: j75mlh3v
            name: My HLS Push Stream Target
            state: activated
            type: custom
            updated_at: '2020-01-31T11:02:53.007Z'
    stream_target_custom:
      type: object
      description: ''
      properties:
        backup_url:
          type: string
          description: >-
            The backup ingest URL for a custom stream target. Not for use with
            the akamai_cupertino custom *provider*.
          example: ''
        created_at:
          type: string
          description: The date and time that the custom stream target was created.
          example: ''
          format: date-time
        delivery_protocols:
          type: array
          description: >-
            An array of the delivery protocols available for this stream target.
            Available from version 1.7.
          example: ''
          items:
            type: string
        id:
          type: string
          description: >-
            The unique alphanumeric string that identifies the custom stream
            target.
          example: ''
        name:
          type: string
          description: >-
            A descriptive name for the custom stream target. Maximum 255
            characters.
          example: ''
        password:
          type: string
          description: >-
            A *username* must be present. The password associated with the
            target username for RTMP authentication. Not for use with the
            akamai_cupertino custom *provider*.
          example: ''
        playback_urls:
          type: object
          description: >-
            Web addresses that the target uses to play streams. Available from
            version 1.7.
          properties:
            hls:
              type: array
              description: Web address that the target uses to play HLS streams.
              items:
                type: object
                title: hls
                properties:
                  name:
                    type: string
                    description: The name of the playback URL.
                    example: default
                  url:
                    type: string
                    description: The playback URL.
                    example: ''
            hds:
              type: array
              description: >-
                Web address that the target uses to play HDS streams. Not for
                use with the akamai_cupertino custom *provider*.
              items:
                type: object
                title: hds
                properties:
                  name:
                    type: string
                    description: The name of the playback URL.
                    example: default
                  url:
                    type: string
                    description: The playback URL.
                    example: ''
            rtmp:
              type: array
              description: Web address that the target uses to play RTMP streams.
              items:
                type: object
                title: rtmp
                properties:
                  name:
                    type: string
                    description: The name of the playback URL.
                    example: default
                  url:
                    type: string
                    description: The playback URL.
                    example: ''
        primary_url:
          type: string
          description: The primary ingest URL of the custom stream target.
          example: ''
        provider:
          type: string
          description: The CDN for the target.
          example: ''
        stream_name:
          type: string
          description: The name of the stream being ingested into the target.
          example: ''
        updated_at:
          type: string
          description: The date and time that the custom stream target was updated.
          example: ''
          format: date-time
        username:
          type: string
          description: >-
            The username or ID that the target uses for RTMP authentication. Not
            for use with the akamai_cupertino custom *provider*.
          example: ''
      example:
        created_at: '2020-01-28T17:16:22.011Z'
        delivery_protocols:
          - rtmp
        id: RMS45lfvx
        name: My Custom Stream Target
        playback_urls:
          rtmp:
            - name: default
              url: rtmp://cp123456.live.edgefcs.net/live/[EVENT]@654321
        primary_url: rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint
        provider: rtmp
        stream_name: c8467d50@123456
        updated_at: '2020-01-30T19:14:11.011Z'
    stream_target_fastly:
      type: object
      title: stream_target_wowza_cdn
      description: ''
      properties:
        created_at:
          type: string
          description: The date and time that the stream target was created.
          example: ''
          format: date-time
        custom_origin_region:
          type: string
          description: >-
            The region where your Wowza Streaming Engine instance is located.
            Available from version 1.6.
          example: ''
          format: string
        custom_origin_url:
          type: string
          description: >-
            The Wowza Streaming Engine instance's domain or IP address.
            Available from version 1.6.
          example: ''
          format: string
        url_suffix:
          type: string
          description: >-
            The path appended to the end of the playback url to make it a valid
            URL, to have playback through the Wowza Video Flowplayer. This is
            available for HLS playback only and necessary for stream targets
            with a custom origin.


            You must have a **url_suffix** to enable the Share Stream feature
            for this stream target. The Share Stream feature enables you to host
            the player and use the Wowza Video player for your viewers to view
            your stream.   


            Example: "custom_origin/cW8JTDFr"
          example: ''
          format: string
        delivery_protocols:
          type: array
          description: >-
            An array of the delivery protocols available for this stream target.
            Available from version 1.7.
          example: ''
          items:
            type: string
        force_ssl_playback:
          type: boolean
          description: >-
            If **true**, requires users to play the stream over HTTPS. If
            **false**, the default, users can play the stream over HTTPS or
            HTTP.
          example: ''
        geoblock_enabled:
          type: boolean
          description: >-
            If **true**, controls access to the stream from specific locations
            and, optionally, IP addresses. The default is **false**.
          example: ''
        geoblock_by_location:
          type: string
          description: >-
            Specifies whether to **allow** or **deny** access to the stream from
            specific locations. The default is **disabled**.
          example: ''
          enum:
            - allow
            - deny
            - disabled
        geoblock_country_codes:
          type: string
          description: >-
            Required when *geoblock_by_location* is **allow** or **deny**. The
            locations affected by the geo-blocking. Enter a comma-separated list
            of capitalized two-letter ISO 3166-1 country codes. For a list, see
            [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on Wikipedia.
          example: ''
        geoblock_ip_override:
          type: string
          description: >-
            Specifies whether specific IP addresses can override the locations
            that are allowed or restricted. **allow** permits access from IP
            addresses within a location that's been blocked, while **deny**
            restricts access from IP addresses within locations that are
            allowed. The default is **disabled**.
          example: ''
          enum:
            - allow
            - deny
            - disabled
        geoblock_ip_addresses:
          type: string
          description: >-
            Required when *geoblock_ip_override* is **allow** or **deny**.
            Addresses that can access or restrict the stream even if they're
            within a specified geo-blocked location. Enter a comma-separated
            list of IPv4 and IPv6 IP addresses that always allow or deny
            streaming based on the *geoblock_ip_override* value.
          example: ''
        id:
          type: string
          description: The unique alphanumeric string that identifies the stream target.
          example: ''
        name:
          type: string
          description: A descriptive name for the stream target. Maximum 255 characters.
          example: ''
        playback_urls:
          type: object
          description: Web addresses that the target uses to play streams.
          properties:
            hls:
              type: array
              description: Web address that the target uses to play HLS streams.
              items:
                type: object
                title: hls
                properties:
                  name:
                    type: string
                    description: The name of the playback URL.
                    example: default
                  url:
                    type: string
                    description: The playback URL.
                    example: ''
        state:
          type: string
          description: The state of the stream target.
          example: ''
          enum:
            - activated
            - archived
        stream_name:
          type: string
          description: The name of the stream being ingested into the target.
          example: ''
        referer_enabled:
          type: boolean
          description: >-
            If **true**, controls access to the stream from specific domains.
            The client or player requesting access to the stream must send the
            Referer header so the origin of the request can be validated. The
            default is **false**.


            **Note:** If you change *referer_enabled* to **false** after
            configuring the referer policy, then later re-enable it, you'll need
            to re-configure the other referer policy values as well.

            Available from version 1.7. For more information about the Referer
            header, see the [HTTP
            specification](https://tools.ietf.org/html/rfc7231#section-5.5.2).
          example: ''
        referer_allow_empty:
          type: boolean
          description: >-
            The Referer header sent by the client or player can be empty and not
            identify the origin of the request. The default is **false** when
            *referer_enabled* is **true**. While less secure, if you know you'll
            have viewers with a client or player that won't send a Referer
            header, you can specify **true** to allow an empty Referer header so
            those viewers can still access the stream.


            Available from version 1.7.
          example: ''
        referer_policy:
          type: string
          description: >-
            Specifies whether to **allow** or **deny** access to the stream from
            specific domains. The default is **allow** when *referer_enabled* is
            **true**. Specify the domains to allow or deny in *referer_domains*.


            Available from version 1.7.
          example: ''
          enum:
            - allow
            - deny
        referer_domains:
          type: string
          description: >-
            Domains that are either allowed or blocked from accessing the
            stream. Enter a comma-separated list of domains that are always
            allowed or denied access based on the *referer_policy* value.
            Required when *referer_enabled* is **true**.


            We recommend you enter the simplest form of the domain as possible,
            but you do need to build out the domain to the level of subdomains
            you want to allow or deny. You can fully express to the subdomain
            (_mysubdomain.example.com_) to specify that single, specific
            subdomain or you can use a wildcard (&#42;) to cover all subdomains
            at a specific level (_&#42;.example.com_).


            **Example:** _example.com, *.example.com, *.mysubdomain.example.com_


            If you entered the above example value for *referer_domains*, and
            *referer_policy* is **allow**, the following domains are allowed
            access to the stream: <ul> <li>https://example.com</li>
            <li>https://subdomain.example.com, https://subdomain2.example.com,
            etc.</li> <li>https://subdomainA.mysubdomain.example.com,
            https://subdomainB.mysubdomain.example.com, etc.</li> </ul>


            Available from version 1.7.
          example: ''
        token_auth_enabled:
          type: boolean
          description: >-
            If **true**, token authentication protects the stream by ensuring
            that it's delivered only to authorized viewers and can't be shared
            by unauthorized links or player hijacking attacks. The default is
            **false**.
          example: ''
        token_auth_shared_secret:
          type: string
          description: >-
            The shared secret of the token authentication. Must contain only
            hexadecimal characters and be an even number of total characters not
            exceeding 32.
          example: ''
        token_auth_playlist_only:
          type: boolean
          description: >-
            If **true**, Wowza Video uses token authentication to protect the
            master playlist only and leaves individual media playlists and media
            segments unprotected.  This feature enables playback compatibility
            with media players that don’t support the *withCredentials*
            property. It may also be useful when addressing  token auth
            compatibility issues with specific browsers. The default is
            **false**.


            **Note**: If you've enabled MPEG-DASH on your stream target,
            `token_auth_playlist_only` applies to both the `playlist.m3u8` for
            HLS and `manifest.mpd` for MPEG-DASH.
          example: ''
        updated_at:
          type: string
          description: The date and time that the stream target was updated.
          example: ''
          format: date-time
      example:
        id: abc45lfyz
        name: My Wowza CDN Stream Target
        state: activated
        stream_name: 9a00105a
        delivery_protocols:
          - hls
        playback_urls:
          hls:
            - name: default
              url: >-
                https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8
        token_auth_enabled: false
        token_auth_playlist_only: false
        geoblock_enabled: true
        geoblock_by_location: allow
        geoblock_country_codes: DE, US
        geoblock_ip_override: deny
        geoblock_ip_addresses: 77.12.34.567, 78.23.45.678
        referer_enabled: true
        referer_allow_empty: false
        referer_policy: allow
        referer_domains: example.com, example2.com
        force_ssl_playback: false
        created_at: '2020-01-28T17:16:22.086Z'
        updated_at: '2020-01-30T15:33:43.086Z'
    stream_target_facebook:
      type: object
      description: ''
      properties:
        title:
          type: string
          description: The title of the stream target.
          example: ''
        created_at:
          type: string
          description: The date and time that the stream target was created.
          example: ''
          format: date-time
        delivery_protocols:
          type: array
          description: An array of the delivery protocols available for this stream target.
          example: ''
          items:
            type: string
        id:
          type: string
          description: The unique alphanumeric string that identifies the stream target.
          example: ''
        name:
          type: string
          description: A descriptive name for the stream target. Maximum 255 characters.
          example: ''
        description:
          type: string
          description: An optional description of the stream target.
          example: ''
        facebook_privacy:
          type: string
          description: >-
            The Facebook privacy setting that determines who can watch your
            stream.
          example: ''
          enum:
            - self
            - all_friends
            - friends_of_friends
            - everyone
        facebook_resource_id:
          type: integer
          description: >-
            A unique identifier assigned to each individual item (like a post,
            page, ad, or user) within the Facebook platform.
          example: ''
        facebook_resource_type:
          type: string
          description: >-
            The video's destination within Facebook where users can view the
            stream. 
          example: ''
          enum:
            - timeline
        facebook_save_vod:
          type: boolean
          description: >-
            Whether or not the video data should be saved for later consumption
            in VOD format. This is set to **true** by default. This can only be
            set at the time of creation.
          example: ''
        updated_at:
          type: string
          description: The date and time that the stream target was updated.
          example: ''
          format: date-time
        facebook_token:
          type: string
          description: >-
            A unique alphanumeric string that identifies a user, app, or page
            and allows an application to access an API.
          example: ''
        type:
          type: string
          description: The type of stream target returned.
          example: ''
          enum:
            - FacebookStreamTarget
      example:
        created_at: '2020-01-28T17:16:22.011Z'
        id: RMS45lfvx
        type: FacebookStreamTarget
        name: My Facebook Stream Target
        title: My Facebook Stream Target
        description: This is my Facebook stream.
        delivery_protocols:
          - rtmp
        facebook_resource_id: 277111822674604
        facebook_resource_type: timeline
        facebook_save_vod: true
        facebook_token: >-
          EAAX01HBCtQ0BO0LTScgBW4OLwqqI9DZAVLwu6lUDbKhfQH5leQnJu3FvNn9d5p32YZAgKZByLUxKiSZCcZBsUm72TPwnW3NiZCgZAKbn8jkvqUE2TRnVZBcSjeSt3eCctlYS8VPfGRm2Sew9h4C4MNvNtS8FuEckrZCE1putjYaPOWzVphAZCDAZBKlw62u
        facebook_privacy: self
        updated_at: '2020-01-30T19:14:11.011Z'
    stream_target_linkedin:
      type: object
      description: ''
      properties:
        title:
          type: string
          description: The title of the stream target.
          example: ''
        created_at:
          type: string
          description: The date and time that the stream target was created.
          example: ''
          format: date-time
        member_type:
          type: string
          description: >-
            Indicates whether you're streaming into LinkedIn as a person or
            organization.
          example: ''
          enum:
            - person
            - organization
        id:
          type: string
          description: The unique alphanumeric string that identifies the stream target.
          example: ''
        name:
          type: string
          description: A descriptive name for the stream target. Maximum 255 characters.
          example: ''
        description:
          type: string
          description: An optional description of the stream target.
          example: ''
        region:
          type: string
          description: >-
            The region that is closest to the broadcast location of your
            transcoder.
          example: ''
          enum:
            - WEST_US
            - EAST_US_NORTH
            - EAST_US_SOUTH
            - CENTRAL_US
            - SOUTH_CENTRAL_US
            - SOUTH_AMERICA
            - SOUTHEAST_ASIA
            - CENTRAL_INDIA
            - NORTH_EUROPE
            - WEST_EUROPE
        urn:
          type: string
          description: >-
            A globally unique alphanumeric identifier used to represent an
            entity's association in an API.
        member_description:
          type: string
          description: A description of the person or organization.
          example: ''
        updated_at:
          type: string
          description: The date and time that the stream target was updated.
          example: ''
          format: date-time
        access_token:
          type: string
          description: >-
            A unique alphanumeric string that allows access to LinkedIn from
            Wowza Video.
          example: ''
        access_token_expires:
          type: string
          description: >-
            The date the access token expires. When the token expires, you must
            log in again.
          example: ''
          format: date
      example:
        id: RMS45lfvx
        title: LinkedIn Live
        description: This is my LinkedIn Live stream.
        region: WEST_EUROPE
        name: My LinkedIn Stream Target
        urn: Xd4aGv6ZXR
        member_type: person
        member_description: Drew Bennet
        access_token: >-
          AQW4H_TnVj9jgYr7U2WjTTq60R31xsjmSXvdJ_2QHF2h07rqfoa7Jm8fdlV8BHmpOE8cgBGH7e4F8eUcuQrsg_Jam11U4NOdlA7M5C5T6cAwlRJDZ-gGn-eRb97cfqEolZLymX8Mb3RV_DaPCm2NYXsOZUhRbz52cWFnNfdzcFWmo5KqJY8gXD4TwBbNSTu5KW3nRO9X7gQuDSTOvP-IaJFKzSqTxsCDZDrKmi4D9mwPGW1vo9ED4-6CCB9XFGq8Bvn4XOn03AjVY1SM61xP5G5K0aIxM4OnBWgHP3SSEiDpglmrm96mepYc8tuekIsERkaydSfGxTXgOyfKy7kP1HrpXzarBw
        access_token_expires_at: '2024-12-15'
        created_at: '2023-01-28T17:16:22.011Z'
        updated_at: '2024-01-30T19:14:11.011Z'
    index_custom_stream_target:
      type: object
      description: ''
      title: stream_targets_custom
      properties:
        created_at:
          type: string
          description: The date and time that the custom stream target was created.
          example: ''
          format: date-time
        id:
          type: string
          description: >-
            The unique alphanumeric string that identifies the custom stream
            target.
          example: ''
        name:
          type: string
          description: >-
            A descriptive name for the custom stream target. Maximum 255
            characters.
          example: ''
        updated_at:
          type: string
          description: The date and time that the custom stream target was updated.
          example: ''
          format: date-time
    stream_targets_custom:
      type: object
      description: ''
      required:
        - stream_targets_custom
      properties:
        stream_targets_custom:
          type: array
          items:
            $ref: '#/components/schemas/index_custom_stream_target'
      example:
        stream_targets_custom:
          - created_at: '2020-01-28T17:16:22.008Z'
            id: RMS45lfvx
            name: My Custom Stream Target
            updated_at: '2020-01-31T00:44:50.008Z'
          - created_at: '2020-01-28T17:16:22.008Z'
            id: ABC45lxyz
            name: My Second Custom Stream Target
            updated_at: '2020-01-31T02:05:33.008Z'
    custom_stream_target_input:
      type: object
      description: ''
      required:
        - stream_target_custom
      properties:
        stream_target_custom:
          type: object
          title: stream_target_custom
          description: ''
          required:
            - name
            - primary_url
            - provider
            - stream_name
          properties:
            name:
              type: string
              description: >-
                A descriptive name for the custom stream target. Maximum 255
                characters.
              example: My Custom Stream Target
            primary_url:
              type: string
              description: >-
                The primary RTMP ingest URL. Hostnames can't contain
                underscores.
              example: rtmp://p.ep337857.i.akamaientrypoint.net/EntryPoint
            provider:
              type: string
              description: The CDN for the target.
              example: rtmp
              enum:
                - akamai_cupertino
                - rtmp
                - rtmps
            stream_name:
              type: string
              description: >-
                The name of the stream as defined in the target's ingestion
                settings. The protocol, host name, and path components of the
                stream name URL must be 255 characters or less. The query
                strings and parameter components of the stream name URL must be
                1024 characters or less.
              example: c8467d50@337857
            backup_url:
              type: string
              description: >-
                The backup RTMP ingest URL of the custom stream target. Not all
                providers or third-party CDNs provide backup URLs. Not for use
                with the akamai_cuptertino custom *provider*.


                **Note:** When both the primary and backup URLs are used, Wowza
                Video sends the stream to both URLs, allowing a provider or 3rd
                party CDN to improve reliability and prevent playback
                disruption. If you want to use both URLs, make sure you add the
                stream target to the output rendition twice, once with
                *use_stream_target_backup_url* as **false** (the default) and
                once with *use_stream_target_backup_url* as **true**. See <a
                href="https://api.docs.video.wowza.com/index/current/tag/transcoders/#tag/transcoders/operation/createTranscoderOutputOutputStreamTarget">POST
                /transcoders/[ID]/outputs/[ID]/output_stream_targets</a> for
                more information.


                **Example:** <code>"backup_url":
                "rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint"</code>
              example: rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint
            playback_urls:
              type: object
              title: Hash of playback URLs
              description: >-
                Web addresses that the target uses to play streams. Available
                from version 1.7.


                **Example:** See response body sample
              properties:
                hls:
                  type: string
                  description: >-
                    Web address that the target uses to play HLS streams.
                    <br/><br/> The format is a hash where the key is **hls** and
                    the value is the playback URL. <br/>Example&#58;
                    "hls":&nbsp;"http&#58;//&lt;*domain*&gt;/master.m3u8"
                hds:
                  type: string
                  description: >-
                    Web address that the target uses to play HDS streams. Not
                    for use with the akamai_cupertino custom *provider*.
                    <br/><br/>The format is a hash where the key is **hds** and
                    the value is the playback URL. <br/>Example&#58;
                    "hds":&nbsp;"http&#58;//&lt;*domain*&gt;/manifest.f4m"
                rtmp:
                  type: string
                  description: >-
                    Web address that the target uses to play RTMP streams.
                    <br/><br/>The format is a hash where the key is **rtmp** and
                    the value is the playback URL. <br/>Example&#58;
                    "rtmp":&nbsp;"rtmp&#58;//cp319499.live.edgefcs.net/live/c9467d50@337857"
            password:
              type: string
              description: >-
                A *username* must also be present. The password associated with
                the target username for RTMP authentication. Not for use with
                the akamai_cupertino custom *provider*.

                **Example:** <code>"password": "cb1e77e98d"</code>
              example: cb1e77e98d
            username:
              type: string
              description: >-
                The username or ID that the target uses for RTMP authentication.
                Not for use with the akamai_cupertino custom *provider*.
              example: '319699'
    custom_stream_target_create_input:
      description: ''
      allOf:
        - $ref: '#/components/schemas/custom_stream_target_input'
      example:
        stream_target_custom:
          name: My Custom Stream Target
          primary_url: rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint
          provider: rtmp
          stream_name: c8467d50@123456
    custom_stream_target_update_input:
      type: object
      description: ''
      required:
        - stream_target_custom
      properties:
        stream_target_custom:
          type: object
          title: stream_target_custom
          description: ''
          properties:
            backup_url:
              type: string
              description: >-
                The backup RTMP ingest URL of the custom stream target. Not all
                providers or third-party CDNs provide backup URLs. Not for use
                with the akamai_cupertino custom *provider*.


                **Note:** When both the primary and backup URLs are used, Wowza
                Video sends the stream to both URLs, allowing a provider or 3rd
                party CDN to improve reliability and prevent playback
                disruption. If you want to use both URLs, make sure you add the
                stream target to the output rendition twice, once with
                *use_stream_target_backup_url* as **false** (the default) and
                once with *use_stream_target_backup_url* as **true**. See <a
                href="https://api.docs.video.wowza.com/index/current/tag/transcoders/#tag/transcoders/operation/createTranscoderOutputOutputStreamTarget">POST
                /transcoders/[ID]/outputs/[ID]/output_stream_targets</a> for
                more information.


                **Example:** <code>"backup_url":
                "rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint"</code>
              example: rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint
            name:
              type: string
              description: >-
                A descriptive name for the custom stream target. Maximum 255
                characters.


                **Example:** <code>"name": "My Updated Custom Stream
                Target"</code>
              example: My Updated Custom Stream Target
            password:
              type: string
              description: >-
                A *username* must be present. The password associated with the
                target username for RTMP authentication. Not for use with the
                akamai_cupertino custom *provider*.


                **Note:** If you want to clear both username and password for
                RTMP authentication, send an empty string for both username and
                password fields.


                **Example:** <code>"password": "cb1e77e98d"</code>
              example: cb1e77e98d
            playback_urls:
              type: object
              title: Hash of playback URLs
              description: >-
                Web addresses that the target uses to play streams. Available
                from version 1.7.



                **Example:** See response body sample
              properties:
                hls:
                  type: string
                  description: >-
                    Web address that the target uses to play HLS streams.
                    <br/><br/> The format is a hash where the key is **hls** and
                    the value is the playback URL. <br/>Example&#58;
                    "hls":&nbsp;"http&#58;//&lt;*domain*&gt;/master.m3u8"
                hds:
                  type: string
                  description: >-
                    Web address that the target uses to play HDS streams. Not
                    for use with the akamai_cupertino custom *provider*.
                    <br/><br/>The format is a hash where the key is **hds** and
                    the value is the playback URL. <br/>Example&#58;
                    "hds":&nbsp;"http&#58;//&lt;*domain*&gt;/manifest.f4m"
                rtmp:
                  type: string
                  description: >-
                    Web address that the target uses to play RTMP streams.
                    <br/><br/>The format is a hash where the key is **rtmp** and
                    the value is the playback URL. <br/>Example&#58;
                    "rtmp":&nbsp;"rtmp&#58;//cp319499.live.edgefcs.net/live/c9467d50@337857"
            primary_url:
              type: string
              description: >-
                The primary RTMP ingest URL. Hostnames can't contain
                underscores.


                **Example:** <code>"primary_url":
                "rtmp://b.ep337857.i.akamaientrypoint.net/EntryPoint"</code>
              example: rtmp://p.ep337857.i.akamaientrypoint.net/EntryPoint
            provider:
              type: string
              description: |-
                The CDN for the target.

                **Example:** <code>"provider": "akamai_cupertino"</code>
              example: rtmp
              enum:
                - akamai_cupertino
                - rtmp
                - rtmps
            stream_name:
              type: string
              description: >-
                The name of the stream as defined in the target's ingestion
                settings. The protocol, host name, and path components of the
                stream name URL must be 255 characters or less. The query
                strings and parameter components of the stream name URL must be
                1024 characters or less.


                **Example:** <code>"stream_name": "c8467d50@337857"</code>
              example: c8467d50@337857
            username:
              type: string
              description: >-
                The username or ID that the target uses for RTMP authentication.
                Not for use with the akamai_cupertino custom *provider*.


                **Note:** If you want to clear both username and password for
                RTMP authentication, send an empty string for both username and
                password fields.


                **Example:** <code>"username": "319699"</code>
              example: '319699'
          example:
            name: My Updated Custom Stream Target
    custom_stream_target_patch_response:
      type: object
      title: stream_target_custom
      description: ''
      properties:
        backup_url:
          type: string
          description: >-
            The backup ingest URL for a custom stream target. Not for use with
            the akamai_cupertino custom *provider*.
          example: ''
        created_at:
          type: string
          description: The date and time that the custom stream target was created.
          example: ''
          format: date-time
        delivery_protocols:
          type: array
          description: >-
            An array of the delivery protocols available for this stream target.
            Available from version 1.7.
          example: ''
          items:
            type: string
        id:
          type: string
          description: >-
            The unique alphanumeric string that identifies the custom stream
            target.
          example: ''
        name:
          type: string
          description: >-
            A descriptive name for the custom stream target. Maximum 255
            characters.
          example: ''
        password:
          type: string
          description: >-
            A *username* must be present. The password associated with the
            target username for RTMP authentication. Not for use with the
            akamai_cupertino custom *provider*.
          example: ''
        playback_urls:
          type: object
          description: >-
            Web addresses that the target uses to play streams. Available from
            version 1.7.
          properties:
            hls:
              type: array
              description: Web address that the target uses to play HLS streams.
              items:
                type: object
                title: hls
                properties:
                  name:
                    type: string
                    description: The name of the playback URL.
                    example: default
                  url:
                    type: string
                    description: The playback URL.
                    example: ''
            hds:
              type: array
              description: >-
                Web address that the target uses to play HDS streams. Not for
                use with the akamai_cupertino custom *provider*.
              items:
                type: object
                title: hds
                properties:
                  name:
                    type: string
                    description: The name of the playback URL.
                    example: default
                  url:
                    type: string
                    description: The playback URL.
                    example: ''
            rtmp:
              type: array
              description: Web address that the target uses to play RTMP streams.
              items:
                type: object
                title: rtmp
                properties:
                  name:
                    type: string
                    description: The name of the playback URL.
                    example: default
                  url:
                    type: string
                    description: The playback URL.
                    example: ''
        primary_url:
          type: string
          description: The primary ingest URL of the custom stream target.
          example: ''
        provider:
          type: string
          description: The CDN for the target.
          example: ''
        stream_name:
          type: string
          description: The name of the stream being ingested into the target.
          example: ''
        updated_at:
          type: string
          description: The date and time that the custom stream target was updated.
          example: ''
          format: date-time
        username:
          type: string
          description: >-
            he username or ID that the target uses for RTMP authentication. Not
            for use with the akamai_cupertino custom *provider*.
          example: ''
      example:
        created_at: '2020-01-28T17:16:22.011Z'
        delivery_protocols:
          - rtmp
        id: RMS45lfvx
        name: My Updated Custom Stream Target
        playback_urls:
          rtmp:
            - name: default
              url: rtmp://cp123456.live.edgefcs.net/live/[EVENT]@654321
        primary_url: rtmp://p.ep123456.i.akamaientrypoint.net/EntryPoint
        provider: rtmp
        stream_name: c8467d50@123456
        updated_at: '2020-01-30T19:46:22.012Z'
    index_fastly_stream_target:
      type: object
      description: ''
      title: stream_targets_wowza_cdn
      properties:
        created_at:
          type: string
          description: The date and time that the stream target was created.
          example: ''
          format: date-time
        id:
          type: string
          description: The unique alphanumeric string that identifies the stream target.
          example: ''
        name:
          type: string
          description: A descriptive name for the stream target. Maximum 255 characters.
          example: ''
        updated_at:
          type: string
          description: The date and time that the stream target was updated.
          example: ''
          format: date-time
    stream_targets_fastly:
      type: object
      description: ''
      required:
        - stream_targets_wowza_cdn
      properties:
        stream_targets_wowza_cdn:
          type: array
          items:
            $ref: '#/components/schemas/index_fastly_stream_target'
      example:
        stream_targets_fastly:
          - created_at: '2020-01-28T17:16:22.010Z'
            id: abc45lfyz
            name: My Wowza CDN Stream Target
            updated_at: '2020-01-31T12:37:22.010Z'
          - created_at: '2020-01-28T17:16:22.010Z'
            id: rdm45lxyz
            name: My Second Wowza CDN Stream Target
            updated_at: '2020-01-31T14:17:28.010Z'
    stream_target_property_fastly:
      type: object
      title: property
      description: ''
      required:
        - key
        - section
        - value
      properties:
        key:
          type: string
          description: >-
            The key of the property.


            The following table lists the available property keys.


            Key | Description

            ----------------|-------------

            **acao** | Explicitly specifies the origin that can access the
            stream. While most streams won't need the origin explicitly set, you
            might use this property for older players that don't send the
            Referer header in their stream request.

            **chunkSize** | Defines the duration of the time-based audio and
            video chunks that Wowza Video delivers to the target.

            **convertAMFData** | Determines whether Wowza Video converts
            incoming AMF data into ID3 tags.

            **playlistSeconds** | Defines the maximum allowable length of the
            playlist.

            **relativePlaylists** | Allows the viewer to watch the stream over
            HTTP and HTTPS, whichever protocol their browser calls.
          example: ''
          enum:
            - acao
            - chunkSize
            - convertAMFData
            - playlistSeconds
            - relativePlaylists
        section:
          type: string
          description: >-
            The section of the stream target configuration table that contains
            the

            property.



            Section | Valid keys for the section

            ----------------|-------------

            **hls** | **acao**, **chunkSize**, and **convertAMFData**

            **playlist** | **playlistSeconds** and **relativePlaylists**
          example: ''
          enum:
            - hls
            - playlist
        value:
          type: string
          description: >-

            The value of the property.


            The following table provides information about valid values for each
            property key.


            Key(s) | Values for the key

            ----------------|-------------

            **acao** | Displays as **http://&lt;_origin_&gt;**

            **chunkSize** | Valid values are the integers **2**, **4**, **6**,
            **8**, and **10**.

            **convertAMFData** <br/> **relativePlaylists** | Valid values are
            the Booleans **true** and **false**.

            **playlistSeconds** | Valid values are any integer between **6** and
            **28800** (8 hours).
          example: ''
      example:
        key: chunkSize
        section: hls
        value: 6
    fastly_stream_target_input:
      type: object
      description: ''
      required:
        - stream_target_wowza_cdn
      properties:
        stream_target_wowza_cdn:
          type: object
          title: stream_target_wowza_cdn
          description: ''
          required:
            - name
          properties:
            name:
              type: string
              description: >-
                A descriptive name for the stream target. Maximum 255
                characters.
              example: My Wowza CDN Stream Target
            custom_origin_region:
              type: string
              description: >-
                The region where your Wowza Streaming Engine instance is
                located. Available from version 1.6.


                Valid values:
                   * **us** - United States
                   * **eu** - Europe
                   * **asia** - Asia
                   * **sa** - South America
                   * **india** - India


                **Example:** <code>"custom_origin_region": "us"</code>
            custom_origin_url:
              type: string
              description: >-
                The Wowza Streaming Engine instance's domain or IP address
                starting with http:// or https://. Available from version 1.6.


                **Note:** You can find the **Host - Server** address on the home
                page of Wowza Streaming Engine under **Application Connection
                Settings**.
            url_suffix:
              type: string
              description: >-
                The path to append to the end of the playback url to make it a
                valid URL, to have playback through the Wowza Video Flowplayer.
                This is available for HLS playback only and necessary for stream
                targets with a custom origin.


                You must have a **url_suffix** to enable the Share Stream
                feature for this stream target. The Share Stream feature enables
                you to host the player and use the Wowza Video player for your
                viewers to view your stream.   


                Example: "custom_origin/cW8JTDFr"
            delivery_protocols:
              type: array
              description: >-
                Specifies the protocols sent to the stream target. Valid values
                are **hls** and **dash** (MPEG-DASH). The default is **hls**.
                Available from version 1.7.


                **Note:** If you enable more than one protocol, you'll incur
                egress charges for each protocol you select.


                See <a
                href="https://www.wowza.com/docs/protect-streams-for-google-widevine-and-microsoft-playready-devices-with-ezdrm-and-the-wowza-video-rest-api">Protect
                streams for Google Widevine and Microsoft PlayReady devices with
                EZDRM and the Wowza Video REST API</a> for an example of setting
                MPEG-DASH as a delivery protocol for digital rights management
                (DRM) use.


                **Example:** See response body sample
              items:
                type: string
                properties:
                  hls:
                    type: string
                    description: Sends an HLS stream to the stream target.
                  dash:
                    type: string
                    description: Sends a MPEG-DASH stream to the target.
            force_ssl_playback:
              type: boolean
              description: >-
                If **true**, requires users to play the stream over HTTPS. If
                **false**, the default, users can play the stream over HTTPS or
                HTTP.


                **Example:** <code>"force_ssl_playback": true</code>
              example: ''
            geoblock_enabled:
              type: boolean
              description: >-
                If **true**, controls access to the stream from specific
                locations and, optionally, IP addresses. The default is
                **false**.


                **Example:** <code>"geoblock_enabled": true</code>
              example: ''
            geoblock_by_location:
              type: string
              description: >-
                Specifies whether to **allow** or **deny** access to the stream
                from specific locations. The default is **disabled**.


                **Example:** <code>"geoblock_location": "allow"</code>
              example: ''
              enum:
                - allow
                - deny
                - disabled
            geoblock_country_codes:
              type: string
              description: >-
                Required when *geoblock_by_location* is **allow** or **deny**.
                The locations affected by the geo-blocking. Enter a
                comma-separated list of capitalized two-letter ISO 3166-1
                country codes. For a list, see [ISO
                3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on Wikipedia.


                **Example:** <code>"geoblock_country_codes": "CA, DE"</code>
              example: ''
            geoblock_ip_override:
              type: string
              description: >-
                Specifies whether specific IP addresses can override the
                locations that are allowed or restricted. **allow** permits
                access from IP addresses within a location that's been blocked,
                while **deny** restricts access from IP addresses within
                locations that are allowed. The default is **disabled**.


                **Example:** <code>"geoblock_ip_override": "allow"</code>
              example: ''
              enum:
                - allow
                - deny
                - disabled
            geoblock_ip_addresses:
              type: string
              description: >-
                Required when *geoblock_ip_override* is **allow** or **deny**.
                Addresses that can access or restrict the stream even if they're
                within a specified geo-blocked location. Enter a comma-separated
                list of up to about 40 IPv4 and IPv6 IP addresses that always
                allow or deny streaming based on the *geoblock_ip_override*
                value. 


                <blockquote><strong>Troubleshooting:</strong> The limit of 40 IP
                addresses is approximate because  all the security information
                (SSL playback, geoblocking countries and IP addresses, referer
                header,  and token auth) count toward an overall metadata limit.
                If you have fewer than 40 IP addresses and  still receive a 422:
                Invalid Record (Geoblock IP addresses) error, see <a
                href="https://www.wowza.com/docs/geo-block-wowza-cdn-on-fastly-stream-targets-with-the-wowza-video-rest-api#troubleshooting">Geo-block
                Wowza CDN on Fastly stream targets with the Wowza Video REST
                API</a>  for more ways to lower the character
                count.</blockquote>


                **Example:** <code>"geoblock_ip_addresses": "77.12.34.567,
                78.23.45.678"</code>
              example: ''
            properties:
              type: array
              description: >-
                Configures one or more stream target properties. The property
                configuration consists of a key/value pair and the section of
                the stream target configuration table the key/value pair is
                stored in. Available from version 1.7.


                **Example:** See response body sample
              items:
                $ref: '#/components/schemas/stream_target_property_fastly'
            referer_enabled:
              type: boolean
              description: >-
                If **true**, controls access to the stream from specific
                domains. The client or player requesting access to the stream
                must send the Referer header so the origin of the request can be
                validated. The default is **false**.


                **Note:** If you change *referer_enabled* to **false** after
                configuring the referer policy, then later re-enable it, you'll
                need to re-configure the other referer policy values as well.


                Available from version 1.7.


                For more information about the Referer header, see the [HTTP
                specification](https://tools.ietf.org/html/rfc7231#section-5.5.2).


                **Example:** <code>"referer_enabled": true</code>
              example: ''
            referer_allow_empty:
              type: boolean
              description: >-
                The Referer header sent by the client or player can be empty and
                not identify the origin of the request. The default is **false**
                when *referer_enabled* is **true**. While less secure, if you
                know you'll have viewers with a client or player that won't send
                a Referer header, you can specify **true** to allow an empty
                Referer header so those viewers can still access the stream.


                Available from version 1.7.


                **Example:** <code>"referer_allow_empty": true</code>
              example: ''
            referer_policy:
              type: string
              description: >-
                Specifies whether to **allow** or **deny** access to the stream
                from specific domains. The default is **allow** when
                *referer_enabled* is **true**. Specify the domains to allow or
                deny in *referer_domains*.


                Available from version 1.7.


                **Example:** <code>"referer_policy": "allow"</code>
              example: ''
              enum:
                - allow
                - deny
            referer_domains:
              type: string
              description: >-
                Domains that are either allowed or blocked from accessing the
                stream. Enter a comma-separated list of domains that are always
                allowed or denied access based on the *referer_policy* value.
                Required when *referer_enabled* is **true**.


                We recommend you enter the simplest form of the domain as
                possible, but you do need to build out the domain to the level
                of subdomains you want to allow or deny. You can fully express
                to the subdomain (_mysubdomain.example.com_) to specify that
                single, specific subdomain or you can use a wildcard (&#42;) to
                cover all subdomains at a specific level (_&#42;.example.com_).


                **Example:** _example.com, *.example.com,
                *.mysubdomain.example.com_


                If you entered the above example value for *referer_domains*,
                and *referer_policy* is **allow**, the following domains are
                allowed access to the stream: <ul> <li>https://example.com</li>
                <li>https://subdomain.example.com,
                https://subdomain2.example.com, etc.</li>
                <li>https://subdomainA.mysubdomain.example.com,
                https://subdomainB.mysubdomain.example.com, etc.</li> </ul>


                Available from version 1.7.


                **Example:** <code>"referer_domains": "example.com,
                example2.com"</code>
              example: ''
            token_auth_enabled:
              type: boolean
              description: >-
                If **true**, token authentication protects the stream by
                ensuring that it's delivered only to authorized viewers and
                can't be shared by unauthorized links or player hijacking
                attacks. The default is **false**.


                **Example:** <code>"token_auth_enabled": true</code>
              example: ''
            token_auth_shared_secret:
              type: string
              description: >-
                The shared secret of the token authentication. Must contain only
                hexadecimal characters and be an even number of total characters
                not exceeding 32.


                **Example:** <code>"token_auth_shared_secret":
                "12345678ABCDEF"</code>
              example: ''
            token_auth_playlist_only:
              type: boolean
              description: >-
                If **true**, Wowza Video uses token authentication to protect
                the master playlist only and leaves individual media playlists
                and media segments unprotected. This feature enables playback
                compatibility with media players that don’t support the
                *withCredentials* property. It may also be useful when
                addressing token auth compatibility issues with specific
                browsers. The default is **false**.


                **Note**: If you've enabled MPEG-DASH on your stream target,
                `token_auth_playlist_only` applies to both the `playlist.m3u8`
                for HLS and `manifest.mpd` for MPEG-DASH.


                **Example:** <code>"token_auth_playlist_only": true</code>
              example: ''
    fastly_stream_target_create_input:
      description: ''
      allOf:
        - $ref: '#/components/schemas/fastly_stream_target_input'
      example:
        stream_target_fastly:
          name: My Wowza CDN Stream Target
    fastly_stream_target_update_input:
      type: object
      description: ''
      required:
        - stream_target_wowza_cdn
      properties:
        stream_target_wowza_cdn:
          type: object
          title: stream_target_wowza_cdn
          description: ''
          properties:
            name:
              type: string
              description: >-
                A descriptive name for the stream target. Maximum 255
                characters.


                **Example:** <code>"name": "My Updated Wowza CDN Stream
                Target"</code>
              example: My Updated Wowza CDN Stream Target
            custom_origin_region:
              type: string
              description: >-
                The region where your Wowza Streaming Engine instance is
                located. Available from version 1.6.


                Valid values:
                   * **us** - United States
                   * **eu** - Europe
                   * **asia** - Asia
                   * **sa** - South America
                   * **india** - India


                **Example:** <code>"custom_origin_region": "us"</code>
            custom_origin_url:
              type: string
              description: >-
                The Wowza Streaming Engine instance's domain or IP address
                starting with http:// or https://. Available from version 1.6.


                **Note:** You can find the **Host - Server** address on the home
                page of Wowza Streaming Engine under **Application Connection
                Settings**.
            url_suffix:
              type: string
              description: >-
                The path to append to the end of the playback url to make it a
                valid URL, to have playback through the Wowza Video Flowplayer.
                This is available for HLS playback only and necessary for stream
                targets with a custom origin.


                You must have a **url_suffix** to enable the Share Stream
                feature for this stream target. The Share Stream feature enables
                you to host the player and use the Wowza Video player for your
                viewers to view your stream.   


                Example: "custom_origin/cW8JTDFr"
            delivery_protocols:
              type: array
              description: >-
                Specifies the protocols sent to the stream target. Valid values
                are **hls** and **dash** (MPEG-DASH). The default is **hls**.
                Available from version 1.7.


                **Note:** If you enable more than one protocol, you'll incur
                egress charges for each protocol you select.


                See <a
                href="https://www.wowza.com/docs/protect-streams-for-google-widevine-and-microsoft-playready-devices-with-ezdrm-and-the-wowza-video-rest-api">Protect
                streams for Google Widevine and Microsoft PlayReady devices with
                EZDRM and the Wowza Video REST API</a> for an example of setting
                MPEG-DASH as a delivery protocol for digital rights management
                (DRM) use.


                **Example:** See response body sample
              items:
                type: string
                properties:
                  hls:
                    type: string
                    description: Sends an HLS stream to the stream target.
                  dash:
                    type: string
                    description: Sends a MPEG-DASH stream to the target.
            force_ssl_playback:
              type: boolean
              description: >-
                If **true**, requires users to play the stream over HTTPS. If
                **false**, the default, users can play the stream over HTTPS or
                HTTP.


                **Example:** <code>"force_ssl_playback": true</code>
              example: ''
            geoblock_enabled:
              type: boolean
              description: >-
                If **true**, controls access to the stream from specific
                locations and, optionally, IP addresses. The default is
                **false**.


                **Example:** <code>"geoblock_enabled": true</code>
              example: ''
            geoblock_by_location:
              type: string
              description: >-
                Specifies whether to **allow** or **deny** access to the stream
                from specific locations. The default is **disabled**.


                **Example:** <code>"geoblock_location": "allow"</code>
              example: ''
              enum:
                - allow
                - deny
                - disabled
            geoblock_country_codes:
              type: string
              description: >-
                Required when *geoblock_by_location* is **allow** or **deny**.
                The locations affected by the geo-blocking. Enter a
                comma-separated list of capitalized two-letter ISO 3166-1
                country codes. For a list, see [ISO
                3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on Wikipedia.


                **Example:** <code>"geoblock_country_codes": "CA, DE"</code>
              example: ''
            geoblock_ip_override:
              type: string
              description: >-
                Specifies whether specific IP addresses can override the
                locations that are allowed or restricted. **allow** permits
                access from IP addresses within a location that's been blocked,
                while **deny** restricts access from IP addresses within
                locations that are allowed. The default is **disabled**.


                **Example:** <code>"geoblock_ip_override": "allow"</code>
              example: ''
              enum:
                - allow
                - deny
                - disabled
            geoblock_ip_addresses:
              type: string
              description: >-
                Required when *geoblock_ip_override* is **allow** or **deny**.
                Addresses that can access or restrict the stream even if they're
                within a specified geo-blocked location. Enter a comma-separated
                list of up to about 40 IPv4 and IPv6 IP addresses that always
                allow or deny streaming based on the *geoblock_ip_override*
                value.


                <blockquote><strong>Troubleshooting:</strong> The limit of 40 IP
                addresses is approximate because  all the security information
                (SSL playback, geoblocking countries and IP addresses, referer
                header,  and token auth) count toward an overall metadata limit.
                If you have fewer than 40 IP addresses and  still receive a 422:
                Invalid Record (Geoblock IP addresses) error, see <a
                href="https://www.wowza.com/docs/geo-block-wowza-cdn-on-fastly-stream-targets-with-the-wowza-video-rest-api#troubleshooting">Geo-block
                Wowza CDN on Fastly stream targets with the Wowza Video REST
                API</a>  for more ways to lower the character
                count.</blockquote>


                **Example:** <code>"geoblock_ip_addresses": "77.12.34.567,
                78.23.45.678"</code>
              example: ''
            properties:
              type: array
              description: >-
                Configures one or more stream target properties. The property
                configuration consists of a key/value pair and the section of
                the stream target configuration table the key/value pair is
                stored in. Available from version 1.7.


                **Example:** See response body sample
              items:
                $ref: '#/components/schemas/stream_target_property_fastly'
            referer_enabled:
              type: boolean
              description: >-
                If **true**, controls access to the stream from specific
                domains. The client or player requesting access to the stream
                must send the Referer header so the origin of the request can be
                validated. The default is **false**.


                **Note:** If you change *referer_enabled* to **false** after
                configuring the referer policy, then later re-enable it, you'll
                need to re-configure the other referer policy values as well.


                Available from version 1.7. For more information about the
                Referer header, see the [HTTP
                specification](https://tools.ietf.org/html/rfc7231#section-5.5.2).


                **Example:** <code>"referer_enabled": true</code>
              example: ''
            referer_allow_empty:
              type: boolean
              description: >-
                The Referer header sent by the client or player can be empty and
                not identify the origin of the request. The default is **false**
                when *referer_enabled* is **true**. While less secure, if you
                know you'll have viewers with a client or player that won't send
                a Referer header, you can specify **true** to allow an empty
                Referer header so those viewers can still access the stream.


                Available from version 1.7.


                **Example:** <code>"referer_allow_empty": true</code>
              example: ''
            referer_policy:
              type: string
              description: >-
                Specifies whether to **allow** or **deny** access to the stream
                from specific domains. The default is **allow** when
                *referer_enabled* is **true**. Specify the domains to allow or
                deny in *referer_domains*.


                Available from version 1.7.


                **Example:** <code>"referer_policy": "allow"</code>
              example: ''
              enum:
                - allow
                - deny
            referer_domains:
              type: string
              description: >-
                Domains that are either allowed or blocked from accessing the
                stream. Enter a comma-separated list of domains that are always
                allowed or denied access based on the *referer_policy* value.
                Required when *referer_enabled* is **true**.


                We recommend you enter the simplest form of the domain as
                possible, but you do need to build out the domain to the level
                of subdomains you want to allow or deny. You can fully express
                to the subdomain (_mysubdomain.example.com_) to specify that
                single, specific subdomain or you can use a wildcard (&#42;) to
                cover all subdomains at a specific level (_&#42;.example.com_).


                **Example:** _example.com, *.example.com,
                *.mysubdomain.example.com_


                If you entered the above example value for *referer_domains*,
                and *referer_policy* is **allow**, the following domains are
                allowed access to the stream: <ul> <li>https://example.com</li>
                <li>https://subdomain.example.com,
                https://subdomain2.example.com, etc.</li>
                <li>https://subdomainA.mysubdomain.example.com,
                https://subdomainB.mysubdomain.example.com, etc.</li> </ul>

                Available from version 1.7.


                **Example:** <code>"referer_domains": "example.com,
                example2.com"</code>
              example: ''
            token_auth_enabled:
              type: boolean
              description: >-
                If **true**, token authentication protects the stream by
                ensuring that it's delivered only to authorized viewers and
                can't be shared by unauthorized links or player hijacking
                attacks. The default is **false**.


                **Example:** <code>"token_auth_enabled": true</code>
              example: ''
            token_auth_shared_secret:
              type: string
              description: >-
                The shared secret of the token authentication. Must contain only
                hexadecimal characters and be an even number of total characters
                not exceeding 32.


                **Example:** <code>"token_auth_shared_secret":
                "12345678ABCDEF"</code>
              example: ''
            token_auth_playlist_only:
              type: boolean
              description: >-
                If **true**, Wowza Video uses token authentication to protect
                the master playlist only and leaves individual media playlists
                and media segments unprotected. This feature enables playback
                compatibility with media players that don’t support the
                *withCredentials* property. It may also be useful when
                addressing token auth compatibility issues with specific
                browsers. The default is **false**.


                **Note**: If you've enabled MPEG-DASH on your stream target,
                `token_auth_playlist_only` applies to both the `playlist.m3u8`
                for HLS and `manifest.mpd` for MPEG-DASH.


                **Example:** <code>"token_auth_playlist_only": true</code>
              example: ''
          example:
            name: My Updated Wowza CDN Stream Target
    fastly_stream_target_patch_response:
      type: object
      title: stream_target_wowza_cdn
      description: ''
      properties:
        created_at:
          type: string
          description: The date and time that the stream target was created.
          example: ''
          format: date-time
        custom_origin_region:
          type: string
          description: >-
            The region where your Wowza Streaming Engine instance is located.
            Available from version 1.6.
          example: ''
          format: string
        custom_origin_url:
          type: string
          description: >-
            The Wowza Streaming Engine instance's domain or IP address.
            Available from version 1.6.
          example: ''
          format: string
        url_suffix:
          type: string
          description: >-
            The path appended to the end of the playback url to make it a valid
            URL, to have playback through the Wowza Video Flowplayer. This is
            available for HLS playback only and necessary for stream targets
            with a custom origin.


            You must have a **url_suffix** to enable the Share Stream feature
            for this stream target. The Share Stream feature enables you to host
            the player and use the Wowza Video player for your viewers to view
            your stream.   


            Example: "custom_origin/cW8JTDFr"
          example: ''
          format: string
        delivery_protocols:
          type: array
          description: >-
            An array of the delivery protocols available for this stream target.
            Available from version 1.7.
          example: ''
          items:
            type: string
        force_ssl_playback:
          type: boolean
          description: >-
            If **true**, requires users to play the stream over HTTPS. If
            **false**, the default, users can play the stream over HTTPS or
            HTTP.
          example: ''
        geoblock_enabled:
          type: boolean
          description: >-
            If **true**, controls access to the stream from specific locations
            and, optionally, IP addresses. The default is **false**.
          example: ''
        geoblock_by_location:
          type: string
          description: >-
            Specifies whether to **allow** or **deny** access to the stream from
            specific locations. The default is **disabled**.
          example: ''
          enum:
            - allow
            - deny
            - disabled
        geoblock_country_codes:
          type: string
          description: >-
            Required when *geoblock_by_location* is **allow** or **deny**. The
            locations affected by the geo-blocking. Enter a comma-separated list
            of capitalized two-letter ISO 3166-1 country codes. For a list, see
            [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on Wikipedia.
          example: ''
        geoblock_ip_override:
          type: string
          description: >-
            Specifies whether specific IP addresses can override the locations
            that are allowed or restricted. **allow** permits access from IP
            addresses within a location that's been blocked, while **deny**
            restricts access from IP addresses within locations that are
            allowed. The default is **disabled**.
          example: ''
          enum:
            - allow
            - deny
            - disabled
        geoblock_ip_addresses:
          type: string
          description: >-
            Required when *geoblock_ip_override* is **allow** or **deny**.
            Addresses that can access or restrict the stream even if they're
            within a specified geo-blocked location. Enter a comma-separated
            list of IPv4 and IPv6 IP addresses that always allow or deny
            streaming based on the *geoblock_ip_override* value.
          example: ''
        id:
          type: string
          description: The unique alphanumeric string that identifies the stream target.
          example: ''
        name:
          type: string
          description: A descriptive name for the stream target. Maximum 255 characters.
          example: ''
        playback_urls:
          type: object
          description: Web addresses that the target uses to play streams.
          properties:
            hls:
              type: array
              description: Web address that the target uses to play HLS streams.
              items:
                type: object
                title: hls
                properties:
                  name:
                    type: string
                    description: The name of the playback URL.
                    example: default
                  url:
                    type: string
                    description: The playback URL.
                    example: ''
        referer_enabled:
          type: boolean
          description: >-
            If **true**, controls access to the stream from specific domains.
            The client or player requesting access to the stream must send the
            Referer header so the origin of the request can be validated. The
            default is **false**.


            **Note:** If you change *referer_enabled* to **false** after
            configuring the referer policy, then later re-enable it, you'll need
            to re-configure the other referer policy values as well.


            Available from version 1.7. For more information about the Referer
            header, see the [HTTP
            specification](https://tools.ietf.org/html/rfc7231#section-5.5.2).
          example: ''
        referer_allow_empty:
          type: boolean
          description: >-
            The Referer header sent by the client or player can be empty and not
            identify the origin of the request. The default is **false** when
            *referer_enabled* is **true**. While less secure, if you know you'll
            have viewers with a client or player that won't send a Referer
            header, you can specify **true** to allow an empty Referer header so
            those viewers can still access the stream.


            Available from version 1.7.
          example: ''
        referer_policy:
          type: string
          description: >-
            Specifies whether to **allow** or **deny** access to the stream from
            specific domains. The default is **allow** when *referer_enabled* is
            **true**. Specify the domains to allow or deny in *referer_domains*.


            Available from version 1.7.
          example: ''
          enum:
            - allow
            - deny
        referer_domains:
          type: string
          description: >-
            Domains that are either allowed or blocked from accessing the
            stream. Enter a comma-separated list of domains that are always
            allowed or denied access based on the *referer_policy* value.
            Required when *referer_enabled* is **true**.


            We recommend you enter the simplest form of the domain as possible,
            but you do need to build out the domain to the level of subdomains
            you want to allow or deny. You can fully express to the subdomain
            (_mysubdomain.example.com_) to specify that single, specific
            subdomain or you can use a wildcard (&#42;) to cover all subdomains
            at a specific level (_&#42;.example.com_).


            **Example:** _example.com, *.example.com, *.mysubdomain.example.com_


            If you entered the above example value for *referer_domains*, and
            *referer_policy* is **allow**, the following domains are allowed
            access to the stream: <ul> <li>https://example.com</li>
            <li>https://subdomain.example.com, https://subdomain2.example.com,
            etc.</li> <li>https://subdomainA.mysubdomain.example.com,
            https://subdomainB.mysubdomain.example.com, etc.</li> </ul>


            Available from version 1.7.
          example: ''
        state:
          type: string
          description: The state of the stream target.
          example: ''
          enum:
            - activated
            - archived
        stream_name:
          type: string
          description: The name of the stream being ingested into the target.
          example: ''
        token_auth_enabled:
          type: boolean
          description: >-
            If **true**, token authentication protects the stream by ensuring
            that it's delivered only to authorized viewers and can't be shared
            by unauthorized links or player hijacking attacks. The default is
            **false**.
          example: ''
        token_auth_shared_secret:
          type: string
          description: >-
            The shared secret of the token authentication. Must contain only
            hexadecimal characters and be an even number of total characters not
            exceeding 32.
          example: ''
        token_auth_playlist_only:
          type: boolean
          description: >-
            If **true**, Wowza Video uses token authentication to protect the
            master playlist only and leaves individual media playlists and media
            segments  unprotected. This feature enables playback compatibility
            with media players that don’t support the *withCredentials*
            property. It may also be  useful when addressing token auth
            compatibility issues with specific browsers. The default is
            **false**.


            **Note**: If you've enabled MPEG-DASH on your stream target,
            `token_auth_playlist_only` applies to both the `playlist.m3u8` for
            HLS and `manifest.mpd` for MPEG-DASH.
          example: ''
        updated_at:
          type: string
          description: The date and time that the stream target was updated.
          example: ''
          format: date-time
      example:
        id: abc45lfyz
        name: My Updated Wowza CDN Stream Target
        state: activated
        stream_name: 9a00105a
        delivery_protocols:
          - hls
        playback_urls:
          hls:
            - name: default
              url: >-
                https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8
        token_auth_enabled: false
        token_auth_playlist_only: false
        geoblock_enabled: false
        referer_enabled: false
        force_ssl_playback: false
        created_at: '2020-01-28T17:16:22.086Z'
        updated_at: '2020-01-30T18:13:55.087Z'
    stream_target_property:
      type: object
      title: property
      description: >-
        A stream target property. The property configuration consists of a
        key/value pair and the section of the stream target configuration table
        the key/value pair is stored in.
      required:
        - key
        - section
        - value
      properties:
        key:
          type: string
          description: >-
            The key of the property.


            The following table lists the available property keys.


            Key | Description

            ----------------|-------------

            **acao** | Explicitly specifies the origin that can access the
            stream. While most streams won't need the origin explicitly set, you
            might use this property for older players that don't send the
            Referer header in their stream request. <br/><br/>**Available on
            these targets types:** Wowza CDN on Fastly

            **chunkSize** | Defines the duration of the time-based audio and
            video chunks that Wowza Video delivers to the target.
            <br/><br/>**Available on these targets types:** Wowza CDN on Fastly,
            Custom: akamai_cupertino

            **convertAMFData** | Determines whether Wowza Video converts
            incoming AMF data into ID3 tags. <br/><br/>**Available on these
            targets types:** Wowza CDN on Fastly, Custom: akamai_cupertino

            **playlistSeconds** | Defines the maximum allowable length of the
            playlist. <br/><br/>**Available on these targets types:** Wowza CDN
            on Fastly, Custom: akamai_cupertino

            **playSSL** | Determines whether Wowza Video sends the stream from
            the target to the player by using SSL (HTTPS).  
            <br/><br/>**Available on these targets types:** Custom:
            akamai_cupertino

            **sendSSL** | Determines whether Wowza Video sends the stream from
            the transcoder to the target by using SSL (HTTPS).  
            <br/><br/>**Available on these targets types:** Custom:
            akamai_cupertino

            **redundantChunklists** | Determines whether Wowza Video creates
            redundant chunklists within a playlist. If a primary chunklist
            within a playlist fails, players that support redundancy during
            playback can switch to the redundant chunklist. <br/><br/> **Note:**
            Enabling **redundantChunklists** increases playback reliability but
            doubles egress data usage and associated charges.
            <br/><br/>**Available on these targets types:** Custom:
            akamai_cupertino

            **relativePlaylists** | Allows the viewer to watch the stream over
            HTTP and HTTPS, whichever protocol their browser calls.
            <br/><br/>**Available on these targets types:** Wowza CDN on Fastly,
            Custom: akamai_cupertino
          example: ''
          enum:
            - acao
            - chunkSize
            - convertAMFData
            - sendSSL
            - playSSL
            - playlistSeconds
            - redundantChunklists
            - relativePlaylists
        section:
          type: string
          description: >-
            The section of the stream target configuration table that contains
            the

            property.



            Section | Valid keys for the section

            ----------------|-------------

            **hls** | **acao**, **chunkSize**, **convertAMFData**, and
            **sendSSL**

            **playlist** | **playSSL**, **playlistSeconds**,
            **redundantChunklists**, and **relativePlaylists**
          example: ''
          enum:
            - hls
            - playlist
        value:
          type: string
          description: >-

            The value of the property.


            The following table provides information about valid values for each
            property key.


            Key(s) | Values for the key

            ----------------|-------------

            **acao** | Displays as **http://&lt;_origin_&gt;**

            **chunkSize** | Valid values are the integers **2**, **4**, **6**,
            **8**, and **10**.

            **convertAMFData** <br/> **playSSL** <br/> **sendSSL** <br/>
            **redundantChunklists** <br/> **relativePlaylists** | Valid values
            are the Booleans **true** and **false**.

            **playlistSeconds** | Valid values are any integer between **6** and
            **28800** (8 hours).
          example: ''
      example:
        key: chunkSize
        section: hls
        value: 6
    stream_target_properties:
      type: object
      title: properties
      description: ''
      required:
        - properties
      properties:
        properties:
          type: array
          items:
            $ref: '#/components/schemas/stream_target_property'
      example:
        properties:
          - key: acao
            section: hls
            value: http://www.example.com
          - key: chunkSize
            section: hls
            value: 6
          - key: relativePlaylists
            section: playlist
            value: true
    stream_target_property_create_input:
      type: object
      title: property
      description: ''
      required:
        - property
      properties:
        property:
          title: property
          description: A single stream target property.
          $ref: '#/components/schemas/stream_target_property'
    stream_target_properties_create_input:
      type: object
      title: properties
      description: ''
      required:
        - properties
      properties:
        properties:
          type: array
          description: >-
            An array of properties. The property configuration consists of a
            key/value pair and the section of the stream target configuration
            table the key/value pair is stored in. You can only set an array of
            properties on a Fastly or Akamai stream target. Available from
            version 1.7.
          items:
            $ref: '#/components/schemas/stream_target_property'
      example:
        properties:
          - key: acao
            section: hls
            value: http://www.example.com
          - key: chunkSize
            section: hls
            value: 6
          - key: relativePlaylists
            section: playlist
            value: true
    stream_target_property_create_input_repsonse:
      type: object
      title: property
      description: ''
      required:
        - property
      properties:
        property:
          title: property
          description: A single stream target property.
          $ref: '#/components/schemas/stream_target_property'
    stream_target_properties_create_input_response:
      type: object
      title: properties
      description: ''
      required:
        - properties
      properties:
        properties:
          type: array
          description: >-
            An array of properties. The property configuration consists of a
            key/value pair and the section of the stream target configuration
            table the key/value pair is stored in. You can only set an array of
            properties on a Fastly or Akamai stream target. Available from
            version 1.7.
          items:
            $ref: '#/components/schemas/stream_target_property'
      example:
        properties:
          - key: acao
            section: hls
            value: http://www.example.com
          - key: chunkSize
            section: hls
            value: 6
          - key: relativePlaylists
            section: playlist
            value: true
    index_transcoder:
      type: object
      title: transcoders
      description: ''
      properties:
        created_at:
          type: string
          description: The date and time that the transcoder was created.
          example: ''
          format: date-time
        id:
          type: string
          description: The unique alphanumeric string that identifies the transcoder.
          example: ''
        name:
          type: string
          description: A descriptive name for the transcoder. Maximum 200 characters.
          example: ''
        state:
          type: string
          description: The state of the transcoder.
          example: resetting
          enum:
            - starting
            - stopping
            - started
            - stopped
            - resetting
        workflow:
          type: string
          description: >-
            The method by which the transcoder was created, either
            **transcoder** for a transcoder created through the transcoder
            workflow or **live_stream** for a transcoder created automatically
            as part of the live stream workflow.
          example: ''
          enum:
            - live_stream
            - transcoder
        updated_at:
          type: string
          description: The date and time that the transcoder was updated.
          example: ''
          format: date-time
    transcoders:
      type: object
      description: ''
      required:
        - transcoders
      properties:
        transcoders:
          type: array
          items:
            $ref: '#/components/schemas/index_transcoder'
      example:
        transcoders:
          - id: 2lsWj3F9
            name: My transcoder
            workflow: live_stream
            state: stopped
            created_at: '2020-01-28T17:16:22.097Z'
            updated_at: '2020-01-31T01:17:48.097Z'
          - id: VJbkhjzl
            name: My other transcoder
            workflow: transcoder
            state: started
            created_at: '2020-01-28T17:16:22.097Z'
            updated_at: '2020-01-30T16:03:28.097Z'
    transcoder_property:
      type: object
      description: >-
        A single property. The property configuration consists of a key/value
        pair and the section of the transcoder configuration table the key/value
        pair is stored in.
      title: property
      required:
        - section
        - key
        - value
      properties:
        key:
          type: string
          description: >-
            The key of the property.


            The following table lists the available property keys and what
            transcoder table section they're stored in.


            Section | Valid keys for the section

            ----------------|-------------

            **asset_management** | <ul><li>**enabled**</li></ul> <br/>**Note:**
            You need a Wowza Video subscription to access Asset Management.

            **cupertino** |
            <ul><li>**aes128Host**</li><li>**aes128Secret**</li></ul>

            **ezdrm** |
            <ul><li>**username**</li><li>**password**</li><li>**fairPlayAssetId**</li><li>**wideVineContentId**</li></ul>

            **file** |
            <ul><li>**repeat**</li><li>**start_streaming_at**</li></ul>

            **output** | <ul><li>**fitMode**</li><li>**record**</li></ul>

            **recording** | <ul><li>**mp4**</li></ul>

            **rtmp** | <ul><li>**allowDirectPlayback**</li></ul>

            **rtsp** |
            <ul><li>**avSyncMethod**</li><li>**debugRtspSession**</li><li>**maxRtcpWaitTime**</li><li>
            **rtpDePacketizerPacketSorterBufferTime**</li><li>**rtpDePacketizerPacketSorterFlushTime**</li><li>**rtpDePacketizerWrapper**</li><li>**rtpIgnoreSpropParameterSets**</li><li>**rtpIgnoreProfileLevelId**</li><li>**rtpTransportMode**</li><li>**rtspValidationFrequency**</li><li>**rtspFilterUnknownTracks**</li></ul>

            **srt** | <ul><li>**passPhrase**</li></ul>

            **vod_stream** |
            <ul><li>**hls**</li><li>**live2vod**</li></li></ul><br/>**Note:**
            VOD streams require a Fastly stream target with HLS as a delivery
            protocol.
          example: ''
        section:
          type: string
          description: >-
            The section of the transcoder configuration table that contains the
            property.
          example: ''
          enum:
            - asset_management
            - cupertino
            - ezdrm
            - file
            - output
            - recording
            - rtmp
            - rtsp
            - srt
            - vod_stream
        value:
          type: string
          description: >-
            The value of the property.


            The following table provides information about valid values for each
            property key.


            Key(s) | Values for the key

            ----------------|-------------

            **aes128Host** | Specify the URL that devices will use to fetch the
            key to decrypt the stream.

            **aes128Secret** | Specify the 16-byte key that will be used to
            decrypt the stream. The key must be 32 characters in length and can
            only contain hex characters (a-f, A-F, 0-9). The key must match the
            key returned by the **aes128Host**.

            **enabled** | Specify **true** or **false**. Used in the
            **asset_mangement** section.

            **fitMode** | Use **letterbox**, **fit-width**, **fit-height**,
            **crop**, **stretch**, or **match-source**. The default is
            **fit-height**.

            **maxRtcpWaitTime** | Use a whole number, expressed as a string or
            an integer. The default is **2000** (ms).

            **passPhrase** | Use a string between 10-79 characters in length. It
            adds security to a live stream for an incoming SRT stream from your
            device or encoder to Wowza Video. The password protection secures
            the data payload of SRT live streams, ensuring that the transmitted
            content is encrypted and safeguarded against unauthorized
            interception during its journey across the network.

            **record** | Use an output ID associated with the transcoder.

            **rtpDePacketizerPacketSorterBufferTime** | Use an integer,
            expressed as a string or an integer. The default is **500** (ms).

            **rtpDePacketizerPacketSorterFlushTime** | Use an integer, expressed
            as a string or an integer. The default is **10** (ms).

            **rtpDePacketizerWrapper** | Use the string
            **RTPDePacketizerWrapperPacketSorter**.

            **rtpTransportMode** | Use the string **udp** or **interleave** (the
            default).

            **rtspValidationFrequency** | Use a whole number, expressed as a
            string or an integer. The default is **15000** (ms).

            **start_streaming_at** | Specify the month, day, year, and time of
            day that the file should start streaming, expressed as a string.
            Express the value by using the ISO 8601 standard of
            <strong>YYYY-MM-DDTHH:MM:SSZ</strong> where <strong>HH</strong> is a
            24-hour clock in UTC.

            <ul><li>**username**</li><li>**password**</li><li>**fairplayAssetId**</li><li>**wideVineContentId**</li></ul>
            | Use account information and asset IDs from EZDRM. All strings.

            <ul><li>**avSyncMethod**</li><li>**debugRtspSession**</li><li>**mp4**</li><li>**repeat**</li><li>**rtspFilterUnknownTracks**</li><li>**rtpIgnoreSpropParameterSets**</li><li>**rtpIgnoreProfileLevelId**</li></ul>
            | Use **true** or **false**, expressed as a string or a Boolean.

            <ul><li>**hls**</li><li>**live2vod**</li></ul> | Use **true** or
            **false**, expressed as a string or a Boolean. When **true**,
            **hls** generates a VOD stream and **live2vod** replaces the live
            playlist with the VOD playlist after the stream ends so viewers can
            access the VOD stream on the live playback URL. **hls** must be
            **true** to enable **live2VOD**.
          example: ''
    transcoder_create_input:
      type: object
      description: ''
      required:
        - transcoder
      properties:
        transcoder:
          type: object
          title: transcoder
          description: ''
          required:
            - name
            - transcoder_type
            - billing_mode
            - broadcast_location
            - protocol
            - delivery_method
          properties:
            billing_mode:
              type: string
              description: >-
                The billing mode for the transcoder. The default is
                **pay_as_you_go**.


                **pay_as_you_go** — Billed as a single event. A single event is
                use-based and you incur charges for the time spent streaming.


                **twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel
                is unlimited stream time for one channel. This billing mode
                doesn't incur overages, since it's unlimited.
              example: ''
              enum:
                - pay_as_you_go
                - twentyfour_seven
            broadcast_location:
              type: string
              description: >-
                The location where Wowza Video transcodes your stream. Choose a
                location as close as possible to your video source.
              example: ''
              enum:
                - asia_pacific_australia
                - asia_pacific_india
                - asia_pacific_japan
                - asia_pacific_singapore
                - asia_pacific_s_korea
                - asia_pacific_taiwan
                - eu_belgium
                - eu_germany
                - eu_ireland
                - south_america_brazil
                - us_central_iowa
                - us_east_s_carolina
                - us_east_virginia
                - us_west_california
                - us_west_oregon
            delivery_method:
              type: string
              description: >-
                The type of connection between the source encoder and the
                transcoder. The default, **pull**, instructs the transcoder to
                pull the video from the source. **push** instructs the source to
                push the stream to the transcoder. **cdn** uses a stream source
                to deliver the stream to the transcoder.
              example: ''
              enum:
                - pull
                - cdn
                - push
            name:
              type: string
              description: A descriptive name for the transcoder. Maximum 200 characters.
              example: ''
            protocol:
              type: string
              description: >-
                The transport protocol for the source video. The default is
                **rtmp**.
              example: ''
              enum:
                - file
                - rtmp
                - rtsp
                - srt
                - udp
                - webrtc
            transcoder_type:
              type: string
              description: >-
                The type of transcoder, either **transcoded** for streams that
                are transcoded into adaptive bitrate renditions or
                **passthrough** for streams that aren't processed by the
                transcoder. 



                > **Note**: **passthrough** isn't supported in the
                **asia_pacific_singapore** region.



                Default: **transcoded**
              example: ''
              enum:
                - transcoded
                - passthrough
            buffer_size:
              type: integer
              description: >-
                The size, in milliseconds, of the incoming buffer. **0** means
                no buffer. The default is **4000** (4 seconds).


                **Example:** <code>"buffer_size": 4000</code>
              example: ''
              enum:
                - 0
                - 1000
                - 2000
                - 3000
                - 4000
                - 5000
                - 6000
                - 7000
                - 8000
              format: int32
            closed_caption_type:
              type: string
              description: >-
                The type of closed caption data being passed from the source.
                The default, **none**, indicates that no data is being provided.
                **cea** indicates that a CEA closed captioning data stream is
                being provided. **on_text** indicates that an onTextData closed
                captioning data stream is being provided. **both** indicates
                that both CEA and onTextData closed captioning data streams are
                being provided.


                **Example:** <code>"closed_caption_type": "cea"</code>
              example: ''
              enum:
                - none
                - cea
                - on_text
                - both
            delivery_protocols:
              type: array
              description: >-
                An array of playback protocols enabled for this transcoder. By
                default, **rtmp**, **rtsp**, and **wowz** are returned.


                **Example:** See response body sample </code>
              items:
                type: string
            description:
              type: string
              description: >-
                An optional description of the transcoder.


                **Example:** <code>"description": "This transcoder runs our 24/7
                stream."</code>
              example: ''
            disable_authentication:
              type: boolean
              description: >-
                Authentication is required by default for RTMP and RTSP push
                connections from a video source to the transcoder. Specify
                **true** to disable authentication with the video source.


                **Example:** <code>"disable_authentication": false</code>
              example: ''
            idle_timeout:
              type: integer
              description: >-
                The amount of idle time, in seconds, before the transcoder
                automatically shuts down. Valid values are the integers **0**
                (never shuts down) to **172800** (48 hours). The default is
                **1200** (20 minutes).


                **Example:** <code>"idle_timeout": 1600</code>
              example: ''
              format: int32
            low_latency:
              type: boolean
              description: >-
                If **true**, turns off the sort packet buffer and speeds the
                time it takes to decode and deliver video data to the player.
                The default is **false**.


                **Example:** <code>"low_latency": false</code>
              example: ''
            password:
              type: string
              description: >-
                A password for authenticating an RTMP or RTSP push connection.
                Can contain only uppercase and lowercase letters; numbers; and
                the period (.), underscore (_), and hyphen (-) characters. No
                other special characters can be used.


                **Example:** <code>"password": 68332313</code>
              example: ''
            play_maximum_connections:
              type: integer
              description: >-
                The number of users who are allowed to connect directly to the
                transcoder. The minimum and default value is **10**. The maximum
                number of connections varies by the size of the transcoder, with
                the maximum value for the largest transcoder being 300 viewers.


                **Example:** <code>"play_maximum_connections": 30</code>
              example: ''
              format: int32
            properties:
              type: array
              description: >-
                An array of properties to configure. The property configuration
                consists of a key/value pair and the section of the transcoder
                configuration table the key/value pair is stored in.


                Available from version 1.5.


                **Example:** See response body sample
              items:
                $ref: '#/components/schemas/transcoder_property'
            reference_id:
              type: string
              description: >-
                A unique, alphanumeric ID returned in transcoder webhook
                payloads. Setting a *reference_id* is useful if you have an ID
                in your system or application you want to associate with
                transcoder events that trigger webhooks. Maximum 70 characters.
                Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|


                You can't use brackets or quotation marks.


                See <a
                href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza
                Video Webhook Event Reference Documentation</a> to learn about
                webhooks.


                Available from version 1.7.


                **Example:** <code>"reference_id": "mySystemID_01"</code>
              example: ''
            source_url:
              type: string
              description: >-
                For the *delivery_method* **pull** or *protocol* **file**.


                For **pull**, enter the source's web address without the
                protocol or the trailing slash (/).


                For **file**, enter the source file URL, including the protocol
                (http, https, gs, s3).



                **Example:** <code>"source_url":
                "xyz.streamlock.net/vod/mp4:Movie.mov"</code>
              example: ''
            stream_extension:
              type: string
              description: >-
                For the *delivery_method* **push**. Some encoders append an
                extension to their stream names. If the device you're using does
                this, enter the extension as a period (.) followed by
                alphanumeric characters.


                **Example:** <code>"stream_extension": ".sdp"</code>
              example: ''
            stream_source_id:
              type: string
              description: >-
                For the *delivery_method* **cdn**. The alphanumeric string that
                identifies the stream source that you want to use to deliver the
                stream to the transcoder.


                **Example:** <code>"stream_source_id": "rxHQQpWw"</code>
              example: ''
            suppress_stream_target_start:
              type: boolean
              description: >-
                If **true**, disables stream targets when the transcoder starts.
                If **false** (the default), the targets start when the
                transcoder starts.


                **Example:** <code>"suppress_stream_target_start": false</code>
              example: ''
            username:
              type: string
              description: >-
                A username for authenticating an RTMP or RTSP push connection.
                Can contain only uppercase and lowercase letters; numbers; and
                the period (.), underscore (_), and hyphen (-) characters. No
                other special characters can be used.


                **Example:** <code>"username": "client2"</code>
              example: ''
            watermark:
              type: boolean
              description: >-
                Embeds an image into the transcoded stream for copyright
                protection. Specify **true** to embed a watermark image.



                **Example:** <code>"watermark": true</code>
              example: ''
            watermark_height:
              type: integer
              description: >-
                The height, in pixels, of the watermark image. If blank, Wowza
                Video uses the original image height.


                **Example:** <code>"watermark_height": 80</code>
              example: ''
              format: int32
            watermark_image:
              type: string
              description: >-
                A Base64-encoded string representation of a GIF, JPEG, or PNG
                image that is embedded in all bitrate renditions of the stream.
                Watermark image files must be 2.5 MB or smaller.


                **Example:** <code>"watermark_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>
              example: ''
            watermark_opacity:
              type: integer
              description: >-
                The opacity, or percentage of transparency, of the watermark.
                **0** is fully transparent; **100** is fully opaque.


                **Example:** <code>"watermark_opacity": 75</code>
              example: ''
              enum:
                - 0
                - 1
                - 2
                - 3
                - 4
                - 5
                - 6
                - 7
                - 8
                - 9
                - 10
                - 11
                - 12
                - 13
                - 14
                - 15
                - 16
                - 17
                - 18
                - 19
                - 20
                - 21
                - 22
                - 23
                - 24
                - 25
                - 26
                - 27
                - 28
                - 29
                - 30
                - 31
                - 32
                - 33
                - 34
                - 35
                - 36
                - 37
                - 38
                - 39
                - 40
                - 41
                - 42
                - 43
                - 44
                - 45
                - 46
                - 47
                - 48
                - 49
                - 50
                - 51
                - 52
                - 53
                - 54
                - 55
                - 56
                - 57
                - 58
                - 59
                - 60
                - 61
                - 62
                - 63
                - 64
                - 65
                - 66
                - 67
                - 68
                - 69
                - 70
                - 71
                - 72
                - 73
                - 74
                - 75
                - 76
                - 77
                - 78
                - 79
                - 80
                - 81
                - 82
                - 83
                - 84
                - 85
                - 86
                - 87
                - 88
                - 89
                - 90
                - 91
                - 92
                - 93
                - 94
                - 95
                - 96
                - 97
                - 98
                - 99
                - 100
              format: int32
            watermark_position:
              type: string
              description: >-
                The corner of the video frame in which you want the watermark to
                appear. The default is **top-left**.


                **Example:** <code>"watermark_position": "top-left"</code>
              example: ''
              enum:
                - top-left
                - top-right
                - bottom-left
                - bottom-right
            watermark_width:
              type: integer
              description: >-
                The width, in pixels, of the watermark image. If blank, Wowza
                Video uses the original image width.


                **Example:** <code>"watermark_width": 100</code>
              example: ''
              format: int32
      example:
        transcoder:
          billing_mode: pay_as_you_go
          broadcast_location: us_central_iowa
          delivery_method: pull
          description: My Transcoder Description
          name: My PAYG Transcoder
          protocol: rtmp
          transcoder_type: transcoded
    output_stream_target:
      type: object
      description: ''
      properties:
        created_at:
          type: string
          description: The date and time that the output stream target was created.
          example: ''
          format: date-time
        id:
          type: string
          description: >-
            The unique alphanumeric string that identifies the output stream
            target.
          example: ''
        stream_target:
          $ref: '#/components/schemas/index_stream_target'
        stream_target_id:
          type: string
          description: The unique alphanumeric string that identifies the stream target.
          example: ''
        updated_at:
          type: string
          description: The date and time that the output stream target was updated.
          example: ''
          format: date-time
        use_stream_target_backup_url:
          type: boolean
          description: >-
            Specifies whether the output stream target uses the stream target's
            primary or backup URL.
          example: ''
        target_state:
          type: string
          description: >-
            Specifies whether the stream target is **enabled** or **disabled**.
            This parameter displays in the response when the transcoder or live
            stream associated with the stream target is running and receiving a
            stream. **Enabled** means the stream target is enabled and streaming
            video to its destination. **Disabled** means the stream target is
            disabled and is not streaming video to its destination.
          example: ''
          enum:
            - enabled
            - disabled
      example:
        id: 4Gp5rF23
        stream_target_id: QvvJYJjk
        use_stream_target_backup_url: true
        stream_target:
          id: QvvJYJjk
          name: My provisioned RTMP Stream Target
          type: wowza
          created_at: '2020-01-29T17:16:21.965Z'
          updated_at: '2020-01-31T04:06:40.965Z'
    output:
      type: object
      description: ''
      properties:
        aspect_ratio_height:
          type: integer
          description: >-
            The height, in pixels, of the output rendition. Should correspond to
            a widescreen or standard aspect ratio and be divisible by 8. The
            default is **1080**. Combined with **aspect_ratio_width**, makes up
            the input resolution.
          example: ''
          format: int32
        aspect_ratio_width:
          type: integer
          description: >-
            The width, in pixels, of the output rendition. Should correspond to
            a widescreen or standard aspect ratio and be divisible by 8. The
            default is **1920**. Combined with **aspect_ratio_height**, makes up
            the input resolution.
          example: ''
          format: int32
        bitrate_audio:
          type: integer
          description: >-
            The audio bitrate, in kilobits per second (Kbps). Must be between
            **1** and **9999**. If the **audio_codec** is **opus**, the default
            is **510**, otherwise the default is **128**.
          example: ''
          format: int32
        bitrate_video:
          type: integer
          description: >-
            The video bitrate, in kilobits per second (Kbps). Must be between
            **1** and **10240**. The default is **4000**.
          example: ''
          format: int32
        created_at:
          type: string
          description: The date and time that the output rendition was created.
          example: ''
          format: date-time
        framerate_reduction:
          type: string
          description: >-
            Reduce the frame rate of the transcoded output rendition. The
            default, **0**, uses the encoded stream's frame rate without
            reduction.
          example: ''
          enum:
            - '0'
            - 1/2
            - 1/4
            - 1/25
            - 1/30
            - 1/50
            - 1/60
        h264_profile:
          type: string
          description: >-
            The encoding method. Specify **main** for desktop streaming,
            **baseline** for playback on mobile devices, or **high** for HD
            playback. The default is **high**.
          example: ''
          enum:
            - main
            - baseline
            - high
        id:
          type: string
          description: The unique alphanumeric string that identifies the output rendition.
          example: ''
        type:
          type: string
          description: >-
            The type of output rendition, be it WebRTC to use with a transcoder
            that uses WebRTC as the protocol or a normal output rendition.
          example: ''
          enum:
            - WebRtcOutput
            - Output
        keyframes:
          type: string
          description: >-
            The interval used to define the compression applied to a group of
            frames. The default, **follow_source**, uses the keyframe interval
            of the source video.
          example: ''
          enum:
            - follow_source
            - '25'
            - '30'
            - '50'
            - '60'
            - '100'
            - '120'
        name:
          type: string
          description: A descriptive name for the output (generated, not writable).
          example: ''
        delete_restrictions:
          type: array
          description: The reasons why the output cannot be deleted.
          example: ''
          items:
            type: string
        output_stream_targets:
          type: array
          items:
            $ref: '#/components/schemas/output_stream_target'
        video_codec:
          type: string
          description: >-
            The codec used to encode the video stream. **disabled** sends the
            stream without a video track and **passthrough** sends the stream
            without transcoding the video track. Available from version 1.6.
          example: ''
          enum:
            - h264
            - passthrough
            - disabled
        audio_codec:
          type: string
          description: >-
            The codec used to encode the audio stream. **disabled** sends the
            stream without an audio track and **passthrough** sends the stream
            without transcoding the audio track. **aac** is the most commonly
            compatible audio codec for protocols, while **opus** is for WebRTC
            streams. Available from version 1.6.
          example: ''
          enum:
            - aac
            - opus
            - passthrough
            - disabled
        transcoder_id:
          type: string
          description: The unique alphanumeric string that identifies the transcoder.
          example: ''
        updated_at:
          type: string
          description: The date and time that the output rendition was updated.
          example: ''
          format: date-time
      example:
        aspect_ratio_height: 480
        aspect_ratio_width: 848
        bitrate_audio: 128
        bitrate_video: 1600
        created_at: '2020-01-29T17:16:21.964Z'
        framerate_reduction: 1/2
        h264_profile: main
        id: w9vJm3BJ
        keyframes: follow_source
        name: 'Standard Output: Video (848 x 480) + Audio'
        output_stream_targets:
          - {}
        video_codec: h264
        audio_codec: aac
        transcoder_id: PblTJm1t
        updated_at: '2020-01-31T13:47:33.964Z'
    transcoder:
      type: object
      description: ''
      properties:
        application_name:
          type: string
          description: The application name from the pull stream source URL.
          example: ''
        asset_id:
          type: string
          description: >-
            Only applies to the transcoder of a live stream created from
            re-streaming an asset in Asset Management. The id for the asset
            associated with the re-streamed live stream. You can manage this
            asset in Asset Management.
        billing_mode:
          type: string
          description: >-
            The billing mode for the transcoder. The default is
            **pay_as_you_go**.


                
            **pay_as_you_go** — Billed as a single event. A single event is
            use-based and you incur charges for the time spent streaming.
                

            **twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel is
            unlimited stream time for one channel. This billing mode doesn't
            incur overages, since it's unlimited.
          example: ''
          enum:
            - pay_as_you_go
            - twentyfour_seven
        broadcast_location:
          type: string
          description: >-
            The location where Wowza Video transcodes your stream. Choose a
            location as close as possible to your video source.
          example: ''
          enum:
            - asia_pacific_australia
            - asia_pacific_india
            - asia_pacific_japan
            - asia_pacific_singapore
            - asia_pacific_s_korea
            - asia_pacific_taiwan
            - eu_belgium
            - eu_germany
            - eu_ireland
            - south_america_brazil
            - us_central_iowa
            - us_east_s_carolina
            - us_east_virginia
            - us_west_california
            - us_west_oregon
        buffer_size:
          type: integer
          description: >-
            The size, in milliseconds, of the incoming buffer. **0** means no
            buffer. The default is **4000** (4 seconds).
          example: ''
          enum:
            - 0
            - 1000
            - 2000
            - 3000
            - 4000
            - 5000
            - 6000
            - 7000
            - 8000
          format: int32
        closed_caption_type:
          type: string
          description: >-
            The type of closed caption data being passed from the source. The
            default, **none**, indicates that no data is being provided. **cea**
            indicates that a CEA closed captioning data stream is being
            provided. **on_text** indicates that an onTextData closed captioning
            data stream is being provided. **both** indicates that both CEA and
            onTextData closed captioning data streams are being provided.
          example: ''
          enum:
            - none
            - cea
            - on_text
            - both
        created_at:
          type: string
          description: The date and time that the transcoder was created.
          example: ''
          format: date-time
        delivery_method:
          type: string
          description: >-
            The type of connection between the source encoder and the
            transcoder. The default, **pull**, instructs the transcoder to pull
            the video from the source. **push** instructs the source to push the
            stream to the transcoder. **cdn** uses a stream source to deliver
            the stream to the transcoder.
          example: ''
          enum:
            - pull
            - cdn
            - push
        delivery_protocols:
          type: array
          description: >-
            An array of playback protocols enabled for this transcoder. By
            default, **rtmp**, **rtsp**, **webrtc**, and **wowz** are returned.
          items:
            type: string
        description:
          type: string
          description: An optional description of the transcoder.
          example: ''
        direct_playback_urls:
          type: object
          description: >-
            A list of direct playback URLs for the transcoder's delivery
            protocols. Each protocol has a URL for the source and a URL for each
            output rendition.
          properties:
            delivery_protocol:
              type: array
              description: The name of the direct playback protocol.
              items:
                type: object
                title: direct_playback_url
                properties:
                  name:
                    type: string
                    description: >-
                      The name of the playback URL: **source**, **default**, or
                      the output rendition's resolution.
                    example: ''
                  output_id:
                    type: string
                    description: >-
                      Only for output rendition-based playback URLs, not source
                      playback URLs. The unique alphanumeric string that
                      identifies the output rendition.
                    example: dcxq5q6c
                  url:
                    type: string
                    description: The playback URL for the source or output rendition.
                    example: >-
                      https://abcdef.dev.entrypoint.video.wowza.com/app-B8P6K226/ngrp:43a23e5a_all/playlist.m3u8
                  application_name:
                    type: string
                    description: (WebRTC only) The application name for the WebRTC output.
                    example: ''
                  stream_name:
                    type: string
                    description: >-
                      (WebRTC only) The stream name for the WebRTC output
                      rendition.
                    example: ''
        disable_authentication:
          type: boolean
          description: >-
            Authentication is required by default for RTMP and RTSP push
            connections from a video source to the transcoder. Specify **true**
            to disable authentication with the video source.
          example: ''
        domain_name:
          type: string
          description: The domain name from the pull stream source URL.
          example: ''
        id:
          type: string
          description: The unique alphanumeric string that identifies the transcoder.
          example: ''
        idle_timeout:
          type: integer
          description: >-
            The amount of idle time, in seconds, before the transcoder
            automatically shuts down. Valid values are the integers **0** (never
            shuts down) to **172800** (48 hours). The default is **1200** (20
            minutes).
          example: ''
          format: int32
        low_latency:
          type: boolean
          description: >-
            If **true**, turns off the sort packet buffer and speeds the time it
            takes to decode and deliver video data to the player. The default is
            **false**.
          example: ''
        name:
          type: string
          description: A descriptive name for the transcoder. Maximum 200 characters.
          example: ''
        outputs:
          type: array
          description: Output renditions associated with the transcoder.
          items:
            $ref: '#/components/schemas/output'
        password:
          type: string
          description: >-
            A password for authenticating an RTMP or RTSP push connection. Can
            contain only uppercase and lowercase letters; numbers; and the
            period (.), underscore (_), and hyphen (-) characters. No other
            special characters can be used.
          example: ''
        playback_stream_name:
          type: string
          description: The stream name used in the direct playback URL.
          example: ''
        play_maximum_connections:
          type: integer
          description: >-
            The number of users who are allowed to connect directly to the
            transcoder. The minimum and default value is **10**. The maximum
            number of connections varies by the size of the transcoder, with the
            maximum value for the largest transcoder being 300 viewers.
          example: ''
          format: int32
        protocol:
          type: string
          description: >-
            The transport protocol for the source video. The default is
            **rtmp**.
          example: ''
          enum:
            - file
            - rtmp
            - rtsp
            - srt
            - udp
            - webrtc
        reference_id:
          type: string
          description: >-
            A unique, alphanumeric ID returned in transcoder webhook payloads.
            Setting a *reference_id* is useful if you have an ID in your system
            or application you want to associate with transcoder events that
            trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z
            0-9 !@#$%^&*()-_+=:;,.?~|


            You can't use brackets or quotation marks.


            See <a
            href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza
            Video Webhook Event Reference Documentation</a> to learn about
            webhooks.


            Available from version 1.7.
          example: ''
        source_port:
          type: integer
          description: The port used for RTMP pull connections to Wowza Video.
          example: ''
          format: int32
        source_url:
          type: string
          description: >-
            For the *delivery_method* **pull** or *protocol* **file**.


            For **pull**, enter the source's web address without the preceding
            protocol or the trailing slash (/).


            For **file**, enter the source file URL, including the protocol
            (http, https, gs, s3).
          example: ''
        stream_extension:
          type: string
          description: >-
            For the *delivery_method* **push**. Some encoders append an
            extension to their stream names. If the device you're using does
            this, enter the extension as a period (.) followed by alphanumeric
            characters.
          example: ''
        stream_name:
          type: string
          description: The stream name from the pull stream source URL.
          example: ''
        stream_source_id:
          type: string
          description: >-
            For the *delivery_method* **cdn**. The alphanumeric string that
            identifies the stream source that you want to use to deliver the
            stream to the transcoder.
          example: ''
        suppress_stream_target_start:
          type: boolean
          description: >-
            If **true**, disables stream targets when the transcoder starts. If
            **false** (the default), the targets start when the transcoder
            starts.
          example: ''
        transcoder_type:
          type: string
          description: >-
            The type of transcoder, either **transcoded** for streams that are
            transcoded into adaptive bitrate renditions or **passthrough** for
            streams that aren't processed by the transcoder. 



             > **Note**: **passthrough** isn't supported in the **asia_pacific_singapore** region.



            Default: **transcoded**
          example: ''
          enum:
            - transcoded
            - passthrough
        updated_at:
          type: string
          description: The date and time that the transcoder was updated.
          example: ''
          format: date-time
        username:
          type: string
          description: >-
            A username for authenticating an RTMP or RTSP push connection. Can
            contain only uppercase and lowercase letters; numbers; and the
            period (.), underscore (_), and hyphen (-) characters. No other
            special characters can be used.
          example: ''
        watermark:
          type: boolean
          description: >-
            Embeds an image into the transcoded stream for copyright protection.
            Specify **true** to embed a watermark image.
          example: ''
        watermark_height:
          type: integer
          description: >-
            The height, in pixels, of the watermark image. If blank, Wowza Video
            uses the original image height.
          example: ''
          format: int32
        watermark_image_url:
          type: string
          description: >-
            The path to a GIF, JPEG, or PNG image that is embedded in all
            bitrate renditions of the stream. Watermark image files must be 2.5
            MB or smaller.
          example: ''
        watermark_opacity:
          type: integer
          description: >-
            The opacity, or percentage of transparency, of the watermark. **0**
            is fully transparent; **100** is fully opaque.
          example: ''
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
            - 16
            - 17
            - 18
            - 19
            - 20
            - 21
            - 22
            - 23
            - 24
            - 25
            - 26
            - 27
            - 28
            - 29
            - 30
            - 31
            - 32
            - 33
            - 34
            - 35
            - 36
            - 37
            - 38
            - 39
            - 40
            - 41
            - 42
            - 43
            - 44
            - 45
            - 46
            - 47
            - 48
            - 49
            - 50
            - 51
            - 52
            - 53
            - 54
            - 55
            - 56
            - 57
            - 58
            - 59
            - 60
            - 61
            - 62
            - 63
            - 64
            - 65
            - 66
            - 67
            - 68
            - 69
            - 70
            - 71
            - 72
            - 73
            - 74
            - 75
            - 76
            - 77
            - 78
            - 79
            - 80
            - 81
            - 82
            - 83
            - 84
            - 85
            - 86
            - 87
            - 88
            - 89
            - 90
            - 91
            - 92
            - 93
            - 94
            - 95
            - 96
            - 97
            - 98
            - 99
            - 100
          format: int32
        watermark_position:
          type: string
          description: >-
            The corner of the video frame in which you want the watermark to
            appear. The default is **top-left**.
          example: ''
          enum:
            - top-left
            - top-right
            - bottom-left
            - bottom-right
        watermark_width:
          type: integer
          description: >-
            The width, in pixels, of the watermark image. If blank, Wowza Video
            uses the original image width.
          example: ''
          format: int32
      example:
        application_name: app-B8P6K226
        billing_mode: pay_as_you_go
        broadcast_location: us_central_iowa
        buffer_size: 4000
        closed_caption_type: cea
        created_at: '2020-01-28T17:16:22.098Z'
        delivery_method: push
        delivery_protocols:
          - rtmp
          - rtsp
          - wowz
          - webrtc
        description: My Transcoder Description
        direct_playback_urls:
          rtmp:
            - name: source
              url: rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789
            - name: webrtc
              output_id: dcxq5q6c
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1
            - name: V:1280x720+A:128K
              output_id: 0g116zkf
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2
            - name: V:854x480+A:128K
              output_id: 4qqkwndt
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3
            - name: V:640x360+A:128K
              output_id: 0pv8djpg
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4
            - name: V:512x288+A:128K
              output_id: b09xrxjf
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5
            - name: V:320x180+A:128K
              output_id: bvkh2nsz
              url: >-
                rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6
          rtsp:
            - name: source
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789
            - name: webrtc
              output_id: dcxq5q6c
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1
            - name: V:1280x720+A:128K
              output_id: 0g116zkf
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2
            - name: V:854x480+A:128K
              output_id: 4qqkwndt
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3
            - name: V:640x360+A:128K
              output_id: 0pv8djpg
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4
            - name: V:512x288+A:128K
              output_id: b09xrxjf
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5
            - name: V:320x180+A:128K
              output_id: bvkh2nsz
              url: >-
                rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6
          wowz:
            - name: source
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789
            - name: webrtc
              output_id: dcxq5q6c
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1
            - name: V:1280x720+A:128K
              output_id: 0g116zkf
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2
            - name: V:854x480+A:128K
              output_id: 4qqkwndt
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3
            - name: V:640x360+A:128K
              output_id: 0pv8djpg
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4
            - name: V:512x288+A:128K
              output_id: b09xrxjf
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5
            - name: V:320x180+A:128K
              output_id: bvkh2nsz
              url: >-
                wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6
          webrtc:
            - name: source
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead
            - name: webrtc
              output_id: dcxq5q6c
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream1
            - name: V:1280x720+A:128K
              output_id: 0g116zkf
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream2
            - name: V:854x480+A:128K
              output_id: 4qqkwndt
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream3
            - name: V:640x360+A:128K
              output_id: 0pv8djpg
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream4
            - name: V:512x288+A:128K
              output_id: b09xrxjf
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream5
            - name: V:320x180+A:128K
              output_id: bvkh2nsz
              url: wss://abc123.entrypoint.video.wowza.com/webrtc-session.json
              application_name: app-B8P6K226
              stream_name: 1722aead_stream6
        disable_authentication: false
        domain_name: f92334.entrypoint.video.wowza.com
        id: 2lsWj3F9
        idle_timeout: 1200
        low_latency: false
        name: My PAYG Transcoder
        outputs:
          - {}
        password: 82e0e971
        playback_stream_name: wxyz6789
        play_maximum_connections: 20
        properties:
          - key: fitMode
            section: output
            value: letterbox
          - key: rtpIgnoreProfileLevelId
            section: rtsp
            value: true
        protocol: rtmp
        reference_id: mySystemID_01
        source_port: 1935
        stream_extension: .sdp
        stream_name: 10eb0ed8
        suppress_stream_target_start: false
        transcoder_type: transcoded
        updated_at: '2020-01-31T15:46:50.098Z'
        username: client2
        watermark: true
        watermark_height: 80
        watermark_image_url: >-
          https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg
        watermark_opacity: 75
        watermark_position: top-right
        watermark_width: 100
    transcoder_update_input:
      type: object
      description: ''
      required:
        - transcoder
      properties:
        transcoder:
          type: object
          title: transcoder
          description: ''
          properties:
            delivery_method:
              type: string
              description: >-
                The type of connection between the source encoder and the
                transcoder. The default, **pull**, instructs the transcoder to
                pull the video from the source. **push** instructs the source to
                push the stream to the transcoder. **cdn** uses a stream source
                to deliver the stream to the transcoder.


                **Example:** <code>"delivery_method": "pull"</code>
              example: ''
              enum:
                - pull
                - cdn
                - push
            name:
              type: string
              description: |-
                A descriptive name for the transcoder. Maximum 200 characters.

                **Example:** <code>"name": "My Updated Transcoder"</code>
              example: ''
            protocol:
              type: string
              description: >-
                The transport protocol for the source video. The default is
                **rtmp**.


                **Example:** <code>"protocol": "webrtc"</code>
              example: ''
              enum:
                - file
                - rtmp
                - rtsp
                - srt
                - udp
                - webrtc
            broadcast_location:
              type: string
              description: >-
                The location where Wowza Video transcodes your stream. Choose a
                location as close as possible to your video source.


                You cannot change the broadcast location after initial creation
                if you are using autostart functionality on your transcoder.


                **Example:** <code>"broadcast_location":
                "us_central_iowa"</code>
              example: ''
              enum:
                - asia_pacific_australia
                - asia_pacific_india
                - asia_pacific_japan
                - asia_pacific_singapore
                - asia_pacific_s_korea
                - asia_pacific_taiwan
                - eu_belgium
                - eu_germany
                - eu_ireland
                - south_america_brazil
                - us_central_iowa
                - us_east_s_carolina
                - us_east_virginia
                - us_west_california
                - us_west_oregon
            buffer_size:
              type: integer
              description: >-
                The size, in milliseconds, of the incoming buffer. **0** means
                no buffer. The default is **4000** (4 seconds).


                **Example:** <code>"buffer_size": 4000</code>
              example: ''
              enum:
                - 0
                - 1000
                - 2000
                - 3000
                - 4000
                - 5000
                - 6000
                - 7000
                - 8000
              format: int32
            closed_caption_type:
              type: string
              description: >-
                The type of closed caption data being passed from the source.
                The default, **none**, indicates that no data is being provided.
                **cea** indicates that a CEA closed captioning data stream is
                being provided. **on_text** indicates that an onTextData closed
                captioning data stream is being provided. **both** indicates
                that both CEA and onTextData closed captioning data streams are
                being provided.


                **Example:** <code>"closed_caption_type": "cea"</code>
              example: ''
              enum:
                - none
                - cea
                - on_text
                - both
            delivery_protocols:
              type: array
              description: >-
                An array of playback protocols enabled for this transcoder. By
                default, **rtmp**, **rtsp**, **webrtc**, and **wowz** are
                returned.


                **Example:** See response body sample </code>
              items:
                type: string
            description:
              type: string
              description: >-
                An optional description of the transcoder.


                **Example:** <code>"description": "This transcoder runs our 24/7
                stream."</code>
              example: ''
            disable_authentication:
              type: boolean
              description: >-
                Authentication is required by default for RTMP and RTSP push
                connections from a video source to the transcoder. Specify
                **true** to disable authentication with the video source.


                **Example:** <code>"disable_authentication": false</code>
              example: ''
            idle_timeout:
              type: integer
              description: >-
                The amount of idle time, in seconds, before the transcoder
                automatically shuts down. Valid values are the integers **0**
                (never shuts down) to **172800** (48 hours). The default is
                **1200** (20 minutes).


                **Example:** <code>"idle_timeout": 1600</code>
              example: ''
              format: int32
            low_latency:
              type: boolean
              description: >-
                If **true**, turns off the sort packet buffer and speeds the
                time it takes to decode and deliver video data to the player.
                The default is **false**.


                **Example:** <code>"low_latency": false</code>
              example: ''
            password:
              type: string
              description: >-
                A password for authenticating an RTMP or RTSP push connection.
                Can contain only uppercase and lowercase letters; numbers; and
                the period (.), underscore (_), and hyphen (-) characters. No
                other special characters can be used.


                **Example:** <code>"password": 68332313</code>
              example: ''
            play_maximum_connections:
              type: integer
              description: >-
                The number of users who are allowed to connect directly to the
                transcoder. The minimum and default value is **10**. The maximum
                number of connections varies by the size of the transcoder, with
                the maximum value for the largest transcoder being 300 viewers.


                **Example:** <code>"play_maximum_connections": 30</code>
              example: ''
              format: int32
            properties:
              type: array
              description: >-
                An array of properties to configure. The property configuration
                consists of a key/value pair and the section of the transcoder
                configuration table the key/value pair is stored in.


                Available from version 1.5.


                **Example:** See response body sample
              items:
                $ref: '#/components/schemas/transcoder_property'
            reference_id:
              type: string
              description: >-
                A unique, alphanumeric ID returned in transcoder webhook
                payloads. Setting a *reference_id* is useful if you have an ID
                in your system or application you want to associate with
                transcoder events that trigger webhooks. Maximum 70 characters.
                Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|


                You can't use brackets or quotation marks.


                See <a
                href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza
                Video Webhook Event Reference Documentation</a> to learn about
                webhooks.


                Available from version 1.7.


                **Example:** <code>"reference_id": "mySystemID_01"</code>
              example: ''
            remove_watermark_image:
              type: boolean
              description: >-
                If **true**, removes the watermark from the output. The default
                is **false**.


                **Example:** <code>"remove_watermark_image": true</code>
              example: ''
            source_url:
              type: string
              description: >-
                For the *delivery_method* **pull** or *protocol* **file**.


                For **pull**, enter the source's web address without the
                protocol or the trailing slash (/).


                For **file**, enter the source file URL, including the protocol
                (http, https, gs, s3).



                **Example:** <code>"source_url":
                "xyz.streamlock.net/vod/mp4:Movie.mov"</code>
              example: ''
            stream_extension:
              type: string
              description: >-
                For the *delivery_method* **push**. Some encoders append an
                extension to their stream names. If the device you're using does
                this, enter the extension as a period (.) followed by
                alphanumeric characters.


                **Example:** <code>"stream_extension": ".sdp"</code>
              example: ''
            stream_source_id:
              type: string
              description: >-
                For the *delivery_method* **cdn**. The alphanumeric string that
                identifies the stream source that you want to use to deliver the
                stream to the transcoder.


                **Example:** <code>"stream_source_id": "rxHQQpWw"</code>
              example: ''
            suppress_stream_target_start:
              type: boolean
              description: >-
                If **true**, disables stream targets when the transcoder starts.
                If **false** (the default), the targets start when the
                transcoder starts.


                **Example:** <code>"suppress_stream_target_start": false</code>
              example: ''
            username:
              type: string
              description: >-
                A username for authenticating an RTMP or RTSP push connection.
                Can contain only uppercase and lowercase letters; numbers; and
                the period (.), underscore (_), and hyphen (-) characters. No
                other special characters can be used.



                **Example:** <code>"username": "client2"</code>
              example: ''
            watermark:
              type: boolean
              description: >-
                Embeds an image into the transcoded stream for copyright
                protection. Specify **true** to embed a watermark image.


                **Example:** <code>"watermark": true</code>
              example: ''
            watermark_height:
              type: integer
              description: >-
                The height, in pixels, of the watermark image. If blank, Wowza
                Video uses the original image height.


                **Example:** <code>"watermark_height": 80</code>
              example: ''
              format: int32
            watermark_image:
              type: string
              description: >-
                A Base64-encoded string representation of a GIF, JPEG, or PNG
                image that is embedded in all bitrate renditions of the stream.
                Watermark image files must be 2.5 MB or smaller.


                **Example:** <code>"watermark_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>
              example: ''
            watermark_opacity:
              type: integer
              description: >-
                The opacity, or percentage of transparency, of the watermark.
                **0** is fully transparent; **100** is fully opaque.


                **Example:** <code>"watermark_opacity": 75</code>
              example: ''
              enum:
                - 0
                - 1
                - 2
                - 3
                - 4
                - 5
                - 6
                - 7
                - 8
                - 9
                - 10
                - 11
                - 12
                - 13
                - 14
                - 15
                - 16
                - 17
                - 18
                - 19
                - 20
                - 21
                - 22
                - 23
                - 24
                - 25
                - 26
                - 27
                - 28
                - 29
                - 30
                - 31
                - 32
                - 33
                - 34
                - 35
                - 36
                - 37
                - 38
                - 39
                - 40
                - 41
                - 42
                - 43
                - 44
                - 45
                - 46
                - 47
                - 48
                - 49
                - 50
                - 51
                - 52
                - 53
                - 54
                - 55
                - 56
                - 57
                - 58
                - 59
                - 60
                - 61
                - 62
                - 63
                - 64
                - 65
                - 66
                - 67
                - 68
                - 69
                - 70
                - 71
                - 72
                - 73
                - 74
                - 75
                - 76
                - 77
                - 78
                - 79
                - 80
                - 81
                - 82
                - 83
                - 84
                - 85
                - 86
                - 87
                - 88
                - 89
                - 90
                - 91
                - 92
                - 93
                - 94
                - 95
                - 96
                - 97
                - 98
                - 99
                - 100
              format: int32
            watermark_position:
              type: string
              description: >-
                The corner of the video frame in which you want the watermark to
                appear. The default is **top-left**.


                **Example:** <code>"watermark_position": "top-left"</code>
              example: ''
              enum:
                - top-left
                - top-right
                - bottom-left
                - bottom-right
            watermark_width:
              type: integer
              description: >-
                The width, in pixels, of the watermark image. If blank, Wowza
                Video uses the original image width.


                **Example:** <code>"watermark_width": 100</code>
              example: ''
              format: int32
      example:
        transcoder:
          name: My Updated Transcoder
          description: My Transcoder Description
          watermark_position: bottom-left
    vod_streams:
      type: object
      description: ''
      required:
        - vod_streams
      properties:
        vod_streams:
          type: array
          items:
            type: object
            title: vod_streams
            description: ''
            properties:
              id:
                type: string
                description: The unique alphanumeric string that identifies the VOD stream.
                example: ''
              name:
                type: string
                description: A descriptive name for the VOD stream. Maximum 200 characters.
                example: ''
              state:
                type: string
                description: The state of the VOD stream.
                example: ''
                enum:
                  - processing
                  - completed
                  - failed
              playback_enabled:
                type: boolean
                description: Specifies whether playback is enabled for the VOD stream.
                example: ''
                enum:
                  - true
                  - false
              reason:
                type: string
                description: >-
                  The reason that a VOD stream has the state of **failed**. Only
                  returned when the state is **failed**.
                example: ''
              created_at:
                type: string
                description: The date and time that the VOD stream was created.
                example: ''
              updated_at:
                type: string
                description: The date and time that the VOD stream was updated.
                example: ''
      example:
        vod_streams:
          - id: wdjfqvsv
            name: My VOD Stream 1
            state: failed
            playback_enabled: false
            created_at: '2020-02-25T17:16:25.849Z'
            updated_at: '2020-01-28T16:06:47.849Z'
          - id: XyxZKqHO
            name: My VOD Stream 2
            state: completed
            playback_enabled: true
            created_at: '2020-01-29T17:16:21.849Z'
            updated_at: '2020-01-31T02:26:05.849Z'
          - id: Pz21DRSt
            name: My VOD Stream 3
            state: completed
            playback_enabled: true
            created_at: '2020-01-29T17:16:21.849Z'
            updated_at: '2020-01-30T18:13:18.849Z'
    uptime:
      type: object
      description: ''
      properties:
        billed:
          type: boolean
          description: >-
            A Boolean value that indicates if the usage generated by this uptime
            has been sent for billing processing.
          example: ''
        created_at:
          type: string
          description: The date and time that the uptime record was created.
          example: ''
          format: date-time
        ended_at:
          type: string
          description: >-
            The date and time that the transcoder was stopped for this uptime.
            If this value is not present, it indicates that the transcoder is
            currently running.
          example: ''
          format: date-time
        id:
          type: string
          description: The unique alphanumeric string that identifies the uptime record.
          example: ''
        running:
          type: boolean
          description: >-
            A Boolean value that indicates if the transcoder is still running
            for this uptime.
          example: ''
        started_at:
          type: string
          description: The date and time that the transcoder started for this uptime.
          example: ''
          format: date-time
        transcoder_id:
          type: string
          description: The unique alphanumeric string that identifies the transcoder.
          example: ''
        updated_at:
          type: string
          description: The date and time that the uptime record was updated.
          example: ''
      example:
        billed: false
        created_at: '2017-07-06T14:22:00.000Z'
        id: 1234abcd
        running: true
        started_at: '2017-07-06T14:22:00.000Z'
        transcoder_id: 2adffc17
        updated_at: '2017-07-06T14:22:00.000Z'
    uptimes:
      type: object
      description: ''
      required:
        - uptimes
      properties:
        uptimes:
          type: array
          items:
            $ref: '#/components/schemas/uptime'
      example:
        uptimes:
          - billed: false
            created_at: '2017-07-06T14:22:00.000Z'
            id: 1234abcd
            running: true
            started_at: '2017-07-06T14:22:00.000Z'
            transcoder_id: 2adffc17
            updated_at: '2017-07-06T14:22:00.000Z'
          - billed: true
            created_at: '2017-07-08T14:22:00.000Z'
            ended_at: '2017-07-08T16:40:00.000Z'
            id: 5679wxyz
            running: false
            started_at: '2017-07-08T14:22:00.000Z'
            transcoder_id: ff9l4838
            updated_at: '2017-07-08T16:40:00.000Z'
    outputs:
      type: object
      description: ''
      required:
        - outputs
      properties:
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/output'
      example:
        outputs:
          - aspect_ratio_height: 480
            aspect_ratio_width: 848
            bitrate_audio: 128
            bitrate_video: 1600
            created_at: '2020-01-29T17:16:21.958Z'
            framerate_reduction: 1/2
            h264_profile: main
            id: w9vJm3BJ
            type: Output
            keyframes: follow_source
            name: 'Standard Output: Video (848 x 480) + Audio'
            output_stream_targets:
              - {}
            video_codec: h264
            audio_codec: aac
            transcoder_id: PblTJm1t
            updated_at: '2020-01-31T03:29:50.958Z'
          - created_at: '2020-01-29T17:16:21.958Z'
            id: PPqV0kcm
            name: 'Standard Output: Video + Audio'
            delete_restrictions:
              - {}
            output_stream_targets:
              - {}
            video_codec: passthrough
            audio_codec: passthrough
            transcoder_id: Yf5lyjCV
            updated_at: '2020-01-31T03:55:05.958Z'
    output_input:
      type: object
      description: ''
      required:
        - output
      properties:
        output:
          type: object
          title: output
          description: ''
          required:
            - video_codec
            - audio_codec
          properties:
            video_codec:
              type: string
              description: >-
                The codec used to encode the video stream. **disabled** sends
                the stream without a video track and **passthrough** sends the
                stream without transcoding the video track. Available from
                version 1.6.
              example: h264
              enum:
                - h264
                - passthrough
                - disabled
            audio_codec:
              type: string
              description: >-
                The codec used to encode the audio stream. **disabled** sends
                the stream without an audio track and **passthrough** sends the
                stream without transcoding the audio track. **aac** is the most
                commonly compatible audio codec for protocols, while **opus** is
                for WebRTC streams. Available from version 1.6.
              example: aac
              enum:
                - aac
                - opus
                - passthrough
                - disabled
            aspect_ratio_height:
              type: integer
              description: >-
                The height, in pixels, of the output rendition. Should
                correspond to a widescreen or standard aspect ratio and be
                divisible by 8. The default is **1080**. Combined with
                **aspect_ratio_width**, makes up the input resolution.


                **Example:** <code>"aspect_ratio_height": 1080</code>
              example: 480
              format: int32
            aspect_ratio_width:
              type: integer
              description: >-
                The width, in pixels, of the output rendition. Should correspond
                to a widescreen or standard aspect ratio and be divisible by 8.
                The default is **1920**. Combined with **aspect_ratio_height**,
                makes up the input resolution.


                **Example:** <code>"aspect_ratio_width": 1920</code>
              example: 848
              format: int32
            bitrate_audio:
              type: integer
              description: >-
                The audio bitrate, in kilobits per second (Kbps). Must be
                between **1** and **9999**. If the **audio_codec** is **opus**,
                the default is **510**, otherwise the default is **128**.


                **Example:** <code>"bitrate_audio": 128</code>
              example: 128
              format: int32
            bitrate_video:
              type: integer
              description: >-
                The video bitrate, in kilobits per second (Kbps). Must be
                between **1** and **10240**. The default is **4000**.


                **Example:** <code>"bitrate_audio": 1600</code>
              example: 1600
              format: int32
            framerate_reduction:
              type: string
              description: >-
                Reduce the frame rate of the transcoded output rendition. The
                default, **0**, uses the encoded stream's frame rate without
                reduction.


                **Example:** <code>"frame_reduction": "1/2"</code>
              example: 1/2
              enum:
                - '0'
                - 1/2
                - 1/4
                - 1/25
                - 1/30
                - 1/50
                - 1/60
            h264_profile:
              type: string
              description: >-
                The encoding method. Specify **main** for desktop streaming,
                **baseline** for playback on mobile devices, or **high** for HD
                playback. The default is **high**.


                **Example:** <code>"h264_profile": "main"</code>
              example: main
              enum:
                - main
                - baseline
                - high
            keyframes:
              type: string
              description: >-
                The interval used to define the compression applied to a group
                of frames. The default, **follow_source**, uses the keyframe
                interval of the source video.


                **Example:** <code>"keyframes": "follow_source"</code>
              example: follow_source
              enum:
                - follow_source
                - '25'
                - '30'
                - '50'
                - '60'
                - '100'
                - '120'
      example:
        output:
          video_codec: h264
          audio_codec: aac
          aspect_ratio_height: 480
          aspect_ratio_width: 848
          bitrate_audio: 128
          bitrate_video: 1600
          framerate_reduction: 1/2
          h264_profile: main
          keyframes: follow_source
    output_create_input:
      description: ''
      allOf:
        - $ref: '#/components/schemas/output_input'
    output_update_input:
      description: ''
      allOf:
        - $ref: '#/components/schemas/output_input'
    output_stream_targets:
      type: object
      description: ''
      required:
        - output_stream_targets
      properties:
        output_stream_targets:
          type: array
          items:
            $ref: '#/components/schemas/output_stream_target'
      example:
        output_stream_targets:
          - id: 4Gp5rF23
            stream_target_id: QvvJYJjk
            use_stream_target_backup_url: false
            stream_target:
              id: QvvJYJjk
              name: My provisioned RTMP Stream Target
              type: wowza
              created_at: '2020-01-29T17:16:21.965Z'
              updated_at: '2020-01-31T05:45:33.965Z'
          - id: 345Gd9Hs
            stream_target_id: R32u8HDk
            use_stream_target_backup_url: false
            stream_target:
              id: R32u8HDk
              name: My other provisioned RTMP Stream Target
              type: wowza
              created_at: '2020-01-29T17:16:21.965Z'
              updated_at: '2020-01-31T12:19:50.965Z'
    output_stream_target_input:
      type: object
      description: ''
      required:
        - output_stream_target
      properties:
        output_stream_target:
          type: object
          title: output_stream_target
          description: ''
          required:
            - stream_target_id
          properties:
            stream_target_id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the stream
                target.
              example: 1234abcd
            use_stream_target_backup_url:
              type: boolean
              description: >-

                Specifies whether the output stream target uses the stream
                target's primary or backup URL.


                When both the primary and backup URLs are used, Wowza Video
                sends the stream to both URLs, allowing a provider or 3rd party
                CDN to improve reliability and prevent playback disruption. If
                you want to use both URLs, make sure you add the stream target
                to the output rendition twice, once with
                *use_stream_target_backup_url* as **false** (the default) and
                once with *use_stream_target_backup_url* as **true**.


                **Example:** <code>"use_stream_target_backup_url": true</code>
              example: true
    output_stream_target_create_input:
      description: ''
      allOf:
        - $ref: '#/components/schemas/output_stream_target_input'
    output_stream_target_update_input:
      description: ''
      allOf:
        - $ref: '#/components/schemas/output_stream_target_input'
    transcoder_configure_properties_post_response:
      type: object
      title: properties
      description: ''
      properties:
        properties:
          type: array
          description: An array of properties.
          items:
            $ref: '#/components/schemas/transcoder_property'
      example:
        properties:
          - key: fitMode
            section: output
            value: letterbox
          - key: rtpIgnoreProfileLevelId
            section: rtsp
            value: true
    transcoder_property_create_input:
      type: object
      title: property
      description: ''
      properties:
        property:
          type: object
          title: property
          description: >-

            The single property to configure. The property configuration
            consists of a key/value pair and the section of the transcoder
            configuration table the key/value pair is stored in.
          required:
            - section
            - key
            - value
          properties:
            key:
              type: string
              description: >-
                The key of the property.


                The following table lists the available property keys and what
                transcoder table section they're stored in.


                Section | Valid keys for the section

                ----------------|-------------

                **asset_management** | <ul><li>**enabled**</li></ul>
                <br/>**Note:** You need a Wowza Video subscription to access
                Asset Management.

                **cupertino** |
                <ul><li>**aes128Host**</li><li>**aes128Secret**</li></ul>

                **ezdrm** |
                <ul><li>**username**</li><li>**password**</li><li>**fairPlayAssetId**</li><li>**wideVineContentId**</li></ul>

                **file** |
                <ul><li>**repeat**</li><li>**start_streaming_at**</li></ul>

                **output** | <ul><li>**fitMode**</li><li>**record**</li></ul>

                **recording** | <ul><li>**mp4**</li></ul>

                **rtmp** | <ul><li>**allowDirectPlayback**</li></ul>

                **rtsp** |
                <ul><li>**avSyncMethod**</li><li>**debugRtspSession**</li><li>**maxRtcpWaitTime**</li><li>
                **rtpDePacketizerPacketSorterBufferTime**</li><li>**rtpDePacketizerPacketSorterFlushTime**</li><li>**rtpDePacketizerWrapper**</li><li>**rtpIgnoreSpropParameterSets**</li><li>**rtpIgnoreProfileLevelId**</li><li>**rtpTransportMode**</li><li>**rtspValidationFrequency**</li><li>**rtspFilterUnknownTracks**</li></ul>

                **srt**  | <ul><li>**passPhrase**</li></ul>

                **vod_stream** |
                <ul><li>**hls**</li><li>**live2vod**</li></li></ul><br/>**Note:**
                VOD streams require a Fastly stream target with HLS as a
                delivery protocol.
              example: rtpIgnoreProfileLevelId
            section:
              type: string
              description: >-
                The section of the transcoder configuration table that contains
                the property.
              example: rtsp
              enum:
                - asset_management
                - cupertino
                - ezdrm
                - file
                - output
                - recording
                - rtmp
                - rtsp
                - srt
                - vod_stream
            value:
              type: string
              description: >-
                The value of the property.


                The following table provides information about valid values for
                each property key.


                Key(s) | Values for the key

                ----------------|-------------

                **aes128Host** | Specify the URL that devices will use to fetch
                the key to decrypt the stream.

                **aes128Secret** | Specify the 16-byte key that will be used to
                decrypt the stream. The key must be 32 characters in length and
                can only contain hex characters (a-f, A-F, 0-9). The key must
                match the key returned by the **aes128Host**.

                **enabled** | Specify **true** or **false**. Used in the
                **asset_mangement** section.

                **fitMode** | Use **letterbox**, **fit-width**, **fit-height**,
                **crop**, **stretch**, or **match-source**. The default is
                **fit-height**.

                **maxRtcpWaitTime** | Use a whole number, expressed as a string
                or an integer. The default is **2000** (ms).

                **passPhrase** | Use a string between 10-79 characters in
                length. It adds security to a live stream for an incoming SRT
                stream from your device or encoder to Wowza Video. The password
                protection secures the data payload of SRT live streams,
                ensuring that the transmitted content is encrypted and
                safeguarded against unauthorized interception during its journey
                across the network.

                **record** | Use an output ID associated with the transcoder.

                **rtpDePacketizerPacketSorterBufferTime** | Use an integer,
                expressed as a string or an integer. The default is **500**
                (ms).

                **rtpDePacketizerPacketSorterFlushTime** | Use an integer,
                expressed as a string or an integer. The default is **10** (ms).

                **rtpDePacketizerWrapper** | Use the string
                **RTPDePacketizerWrapperPacketSorter**.

                **rtpTransportMode** | Use the string **udp** or **interleave**
                (the default).

                **rtspValidationFrequency** | Use a whole number, expressed as a
                string or an integer. The default is **15000** (ms).

                **start_streaming_at** | Specify the month, day, year, and time
                of day that the file should start streaming, expressed as a
                string. Express the value by using the ISO 8601 standard of
                <strong>YYYY-MM-DDTHH:MM:SSZ</strong> where <strong>HH</strong>
                is a 24-hour clock in UTC.

                <ul><li>**username**</li><li>**password**</li><li>**fairplayAssetId**</li><li>**wideVineContentId**</li></ul>
                | Use account information and asset IDs from EZDRM. All strings.

                <ul><li>**avSyncMethod**</li><li>**debugRtspSession**</li><li>**mp4**</li><li>**repeat**</li><li>**rtspFilterUnknownTracks**</li><li>**rtpIgnoreSpropParameterSets**</li><li>**rtpIgnoreProfileLevelId**</li></ul>
                | Use **true** or **false**, expressed as a string or a Boolean.

                <ul><li>**hls**</li><li>**live2vod**</li></ul> | Use **true** or
                **false**, expressed as a string or a Boolean. When **true**,
                **hls** generates a VOD stream and **live2vod** replaces the
                live playlist with the VOD playlist after the stream ends so
                viewers can access the VOD stream on the live playback URL.
                **hls** must be **true** to enable **live2VOD**.
              example: 'true'
    transcoder_properties_create_input:
      type: object
      title: properties
      description: ''
      properties:
        properties:
          type: array
          title: properties
          description: >-
            An array of properties to configure. The property configuration
            consists of a key/value pair and the section of the transcoder
            configuration table the key/value pair is stored in.


            Available from version 1.7.
          required:
            - section
            - key
            - value
          items:
            $ref: '#/components/schemas/transcoder_property'
      example:
        properties:
          - key: fitMode
            section: output
            value: letterbox
          - key: rtpIgnoreProfileLevelId
            section: rtsp
            value: true
    transcoder_configure_property_post_response:
      type: object
      title: property
      description: ''
      properties:
        property:
          description: The configured transcoder property.
          $ref: '#/components/schemas/transcoder_property'
      example:
        property:
          - key: rtpIgnoreProfileLevelId
            section: rtsp
            value: true
    analytics_viewers_account:
      type: object
      description: ''
      properties:
        account:
          type: object
          title: account
          description: ''
          properties:
            viewers:
              type: integer
              description: >-
                The total number of unique viewers to download at least one
                chunk of the stream. A unique viewer is a single IP address;
                multiple users that share the same IP address are counted once.
              example: ''
              format: int32
            countries:
              type: object
              title: countries
              description: An array of viewer countries.
              properties:
                code:
                  type: string
                  description: A country code where the stream was requested.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            renditions:
              type: object
              title: renditions
              description: An array of viewer renditions.
              properties:
                name:
                  type: integer
                  description: >-
                    The rendition of the stream played. A rendition name is the
                    smaller number of the resolution. The resolution is
                    [width]x[height] in which the stream was played. Renditions
                    names have to be unique. If you've created two renditions
                    that have the same height and width, Wowza Video increments
                    the value of the height and uses that as the rendition name.


                    Example: Two renditions of 1280x720 will result in rendition
                    names of 720 and 721.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            devices:
              type: object
              title: devices
              description: An array of viewer devices.
              properties:
                name:
                  type: string
                  description: A device where the stream was played.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            trend:
              type: object
              title: Array of viewer trends
              description: >-
                An array of viewer trend data. The granularity of sampled data
                changes based on the from and to query values you use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>


                <strong>Defaults</strong>: from = last billing date, to = end of
                current day
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**. 
              example: ''
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        account:
          viewers: 7
          countries:
            - code: US
              viewers: 4
            - code: DE
              viewers: 3
          renditions:
            - name: 720
              viewers: 7
          devices:
            - name: Desktop
              viewers: 7
          time_zone: America/New_York
          trend:
            - sampled_at: '2024-03-14T00:00:00Z'
              viewers: 7
            - sampled_at: '2024-03-15T00:00:00Z'
              viewers: 7
            - sampled_at: '2024-03-16T00:00:00Z'
              viewers: 7
            - sampled_at: '2022-01-26T12:04:00Z'
              viewers: 7
        limits:
          from: '2024-03-14T10:31:54.000Z'
          to: '2024-04-13T10:31:54.000Z'
    analytics_viewers_live_stream:
      type: object
      description: ''
      properties:
        live_stream:
          type: object
          title: live_stream
          description: ''
          properties:
            id:
              type: string
              description: The unique alphanumeric string that identifies the live stream.
              format: int32
            viewers:
              type: integer
              description: >-
                The total number of unique viewers to download at least one
                chunk of the stream. A unique viewer is a single IP address;
                multiple users that share the same IP address are counted once.
              example: ''
              format: int32
            countries:
              type: object
              title: countries
              description: An array of viewer countries.
              properties:
                code:
                  type: string
                  description: A country code where the stream was requested.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            renditions:
              type: object
              title: renditions
              description: An array of viewer renditions.
              properties:
                name:
                  type: integer
                  description: >-
                    The rendition of the stream played. A rendition name is the
                    smaller number of the resolution. The resolution is
                    [width]x[height] in which the stream was played. Renditions
                    names have to be unique. If you've created two renditions
                    that have the same height and width, Wowza Video increments
                    the value of the height and uses that as the rendition name.


                    Example: Two renditions of 1280x720 will result in rendition
                    names of 720 and 721.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            devices:
              type: object
              title: devices
              description: An array of viewer devices.
              properties:
                name:
                  type: string
                  description: A device where the stream was played.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            trend:
              type: object
              title: Array of viewer trends
              description: >-
                An array of viewer trend data. The granularity of sampled data
                changes based on the from and to query values you use:


                 <ul><li>0 minutes to 8 hours - Samples returned per minute</li> <li>8 hours, 1 second to 24 hours - Samples returned per hour</li> <li>24 hours, 1 second to 175 days - Samples returned per day</li> <li>175 days to 14 years - Samples returned per month</li> <li>14 years or greater - Samples returned per year</li></ul>


                <strong>Defaults</strong>: from = last billing date, to = end of
                current day
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**. 
              example: ''
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        live_stream:
          id: tvctq36g
          viewers: 7
          countries:
            - code: US
              viewers: 4
            - code: DE
              viewers: 3
          renditions:
            - name: 720
              viewers: 7
          devices:
            - name: Desktop
              viewers: 7
          trend:
            - sampled_at: '2024-03-14T00:00:00Z'
              viewers: 7
            - sampled_at: '2024-03-15T00:00:00Z'
              viewers: 7
            - sampled_at: '2024-03-16T00:00:00Z'
              viewers: 7
            - sampled_at: '2022-01-26T12:04:00Z'
              viewers: 7
          time_zone: America/New_York
        limits:
          from: '2024-03-14T10:31:54.000Z'
          to: '2024-04-13T10:31:54.000Z'
    analytics_viewers_vod_stream:
      type: object
      description: ''
      properties:
        vod_stream:
          type: object
          title: vod_stream
          description: ''
          properties:
            id:
              type: string
              description: The unique alphanumeric string that identifies the VOD stream.
              format: int32
            viewers:
              type: integer
              description: >-
                The total number of unique viewers to download at least one
                chunk of the VOD stream. A unique viewer is a single IP address;
                multiple users that share the same IP address are counted once.
              example: ''
              format: int32
            countries:
              type: object
              title: countries
              description: An array of viewer countries.
              properties:
                code:
                  type: string
                  description: A country code where the stream was requested.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the VOD stream. A unique viewer is a single IP
                    address; multiple users that share the same IP address are
                    counted once.
                  example: ''
                  format: int32
            renditions:
              type: object
              title: renditions
              description: An array of viewer renditions.
              properties:
                name:
                  type: integer
                  description: >-
                    The rendition of the stream played. A rendition name is the
                    smaller number of the resolution. The resolution is
                    [width]x[height] in which the stream was played. Renditions
                    names have to be unique. If you've created two renditions
                    that have the same height and width, Wowza Video increments
                    the value of the height and uses that as the rendition name.


                    Example: Two renditions of 1280x720 will result in rendition
                    names of 720 and 721.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            devices:
              type: object
              title: devices
              description: An array of viewer devices.
              properties:
                name:
                  type: string
                  description: A device where the stream was played.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            trend:
              type: object
              title: Array of viewer trends
              description: >-
                An array of viewer trend data. The granularity of sampled data
                changes based on the from and to query values you use:


                 <ul><li>0 minutes to 8 hours - Samples returned per minute</li> <li>8 hours, 1 second to 24 hours - Samples returned per hour</li> <li>24 hours, 1 second to 175 days - Samples returned per day</li> <li>175 days to 14 years - Samples returned per month</li> <li>14 years or greater - Samples returned per year</li></ul>


                <strong>Defaults</strong>: from = last billing date, to = end of
                current day
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the VOD stream. A unique viewer is a single IP
                    address; multiple users that share the same IP address are
                    counted once.
                  example: ''
                  format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**. 
              example: ''
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        vod_stream:
          id: tvctq36g
          viewers: 7
          countries:
            - code: US
              viewers: 3
            - code: DE
              viewers: 4
          renditions:
            - name: 720
              viewers: 7
          devices:
            - name: Desktop
              viewers: 7
          trend:
            - sampled_at: '2024-03-14T00:00:00Z'
              viewers: 7
            - sampled_at: '2024-03-15T00:00:00Z'
              viewers: 7
            - sampled_at: '2024-03-16T00:00:00Z'
              viewers: 7
            - sampled_at: '2022-01-26T12:04:00Z'
              viewers: 7
          time_zone: America/New_York
        limits:
          from: '2024-03-14T10:31:54.000Z'
          to: '2024-04-13T10:31:54.000Z'
    analytics_viewers_stream_target:
      type: object
      description: ''
      properties:
        stream_target:
          type: object
          title: stream_target
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the stream
                target.
              format: int32
            viewers:
              type: integer
              description: >-
                The total number of unique viewers to download at least one
                chunk of the stream at the target (for HTTP streams). A unique
                viewer is a single IP address; multiple users that share the
                same IP address are counted once.
              example: ''
              format: int32
            countries:
              type: object
              title: countries
              description: An array of viewer countries.
              properties:
                code:
                  type: string
                  description: A country code where the stream was requested.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream at the target (for HTTP streams). A
                    unique viewer is a single IP address; multiple users that
                    share the same IP address are counted once.
                  example: ''
                  format: int32
            renditions:
              type: object
              title: renditions
              description: An array of viewer renditions.
              properties:
                name:
                  type: integer
                  description: >-
                    The rendition of the stream played. A rendition name is the
                    smaller number of the resolution. The resolution is
                    [width]x[height] in which the stream was played. Renditions
                    names have to be unique. If you've created two renditions
                    that have the same height and width, Wowza Video increments
                    the value of the height and uses that as the rendition name.


                    Example: Two renditions of 1280x720 will result in rendition
                    names of 720 and 721.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            devices:
              type: object
              title: devices
              description: An array of viewer devices.
              properties:
                name:
                  type: string
                  description: A device where the stream was played.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            trend:
              type: object
              title: Array of viewer trends
              description: >-
                An array of viewer trend data. The granularity of sampled data
                changes based on the from and to query values you use:


                 <ul><li>0 minutes to 8 hours - Samples returned per minute</li> <li>8 hours, 1 second to 24 hours - Samples returned per hour</li> <li>24 hours, 1 second to 175 days - Samples returned per day</li> <li>175 days to 14 years - Samples returned per month</li> <li>14 years or greater - Samples returned per year</li></ul>


                <strong>Defaults</strong>: from = last billing date, to = end of
                current day
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream at the target (for HTTP streams). A
                    unique viewer is a single IP address; multiple users that
                    share the same IP address are counted once.
                  example: ''
                  format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**. 
              example: ''
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        stream_target:
          id: tvctq36g
          viewers: 7
          countries:
            - code: US
              viewers: 4
            - code: DE
              viewers: 3
          renditions:
            - name: 720
              viewers: 7
          devices:
            - name: Desktop
              viewers: 7
          trend:
            - sampled_at: '2024-03-14T00:00:00Z'
              viewers: 7
            - sampled_at: '2024-03-15T00:00:00Z'
              viewers: 7
            - sampled_at: '2024-03-16T00:00:00Z'
              viewers: 7
            - sampled_at: '2022-01-26T12:04:00Z'
              viewers: 7
          time_zone: America/New_York
        limits:
          from: '2024-03-14T10:31:54.000Z'
          to: '2024-04-13T10:31:54.000Z'
    analytics_viewers_live_streams:
      type: object
      description: ''
      required:
        - live_streams
      properties:
        live_streams:
          type: array
          items:
            type: object
            description: ''
            title: live_streams
            properties:
              id:
                type: string
                description: >-
                  The unique alphanumeric string that identifies the live
                  stream.
                example: 4Jjzstdt
                format: int32
              viewers:
                type: integer
                description: >-
                  The total number of unique viewers to download at least one
                  chunk of the stream. A unique viewer is a single IP address;
                  multiple users that share  the same IP address are counted
                  once.
                example: 3
                format: int32
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        live_streams:
          - id: 4Jjzstdt
            viewers: 3
          - id: fFWxVsyj
            viewers: 4
        limits:
          from: '2023-04-14T10:31:54.486Z'
          to: '2023-07-13T10:31:54.486Z'
    analytics_viewers_vod_streams:
      type: object
      description: ''
      required:
        - vod_streams
      properties:
        vod_streams:
          type: array
          items:
            type: object
            description: ''
            title: vod_streams
            properties:
              id:
                type: string
                description: The unique alphanumeric string that identifies the VOD stream.
                example: 4Jjzstdt
                format: int32
              viewers:
                type: integer
                description: >-
                  The total number of unique viewers to download at least one
                  chunk of the stream. A unique viewer is a single IP address;
                  multiple users that share  the same IP address are counted
                  once.
                example: 3
                format: int32
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        vod_streams:
          - id: 4Jjzstdt
            viewers: 3
          - id: fFWxVsyj
            viewers: 4
        limits:
          from: '2023-04-14T10:31:54.486Z'
          to: '2023-07-13T10:31:54.486Z'
    analytics_viewers_account_total:
      type: object
      description: ''
      properties:
        account:
          type: object
          title: account
          description: ''
          properties:
            viewers:
              type: integer
              description: >-
                The total number of unique viewers to download at least one
                chunk of the stream. A unique viewer is a single IP address;
                multiple users that share the same IP address are counted once.
              example: ''
              format: int32
            countries:
              type: object
              title: countries
              description: An array of viewer countries.
              properties:
                code:
                  type: string
                  description: A country code where the stream was requested.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            renditions:
              type: object
              title: renditions
              description: An array of viewer renditions.
              properties:
                name:
                  type: integer
                  description: >-
                    The rendition of the stream played. A rendition name is the
                    smaller number of the resolution. The resolution is
                    [width]x[height] in which the stream was played. Renditions
                    names have to be unique. If you've created two renditions
                    that have the same height and width, Wowza Video increments
                    the value of the height and uses that as the rendition name.


                    Example: Two renditions of 1280x720 will result in rendition
                    names of 720 and 721.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            devices:
              type: object
              title: devices
              description: An array of viewer devices.
              properties:
                name:
                  type: string
                  description: A device where the stream was played.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
              example: ''
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        account:
          viewers: 7
          countries:
            - code: US
              viewers: 4
            - code: DE
              viewers: 3
          renditions:
            - name: 720
              viewers: 7
          devices:
            - name: Desktop
              viewers: 7
          time_zone: America/New_York
        limits:
          from: '2024-04-01T00:00:00.000Z'
          to: '2024-04-09T14:20:03.000Z'
    analytics_viewers_live_stream_total:
      type: object
      description: ''
      properties:
        live_stream:
          type: object
          title: live_stream
          description: ''
          properties:
            id:
              type: string
              description: The unique alphanumeric string that identifies the live stream.
              format: int32
            viewers:
              type: integer
              description: >-
                The total number of unique viewers to download at least one
                chunk of the stream. A unique viewer is a single IP address;
                multiple users that share the same IP address are counted once.
              example: ''
              format: int32
            countries:
              type: object
              title: countries
              description: An array of viewer countries.
              properties:
                code:
                  type: string
                  description: A country code where the stream was requested.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            renditions:
              type: object
              title: renditions
              description: An array of viewer renditions.
              properties:
                name:
                  type: integer
                  description: >-
                    The rendition of the stream played. A rendition name is the
                    smaller number of the resolution. The resolution is
                    [width]x[height] in which the stream was played. Renditions
                    names have to be unique. If you've created two renditions
                    that have the same height and width, Wowza Video increments
                    the value of the height and uses that as the rendition name.


                    Example: Two renditions of 1280x720 will result in rendition
                    names of 720 and 721.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            devices:
              type: object
              title: devices
              description: An array of viewer devices.
              properties:
                name:
                  type: string
                  description: A device where the stream was played.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**. 
              example: ''
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        live_stream:
          id: tvctq36g
          viewers: 7
          countries:
            - code: US
              viewers: 4
            - code: DE
              viewers: 3
          renditions:
            - name: 720
              viewers: 7
          devices:
            - name: Desktop
              viewers: 7
          time_zone: America/New_York
        limits:
          from: '2024-04-01T00:00:00.000Z'
          to: '2024-04-09T14:20:03.000Z'
    analytics_viewers_vod_stream_total:
      type: object
      description: ''
      properties:
        vod_stream:
          type: object
          title: vod_stream
          description: ''
          properties:
            id:
              type: string
              description: The unique alphanumeric string that identifies the VOD stream.
              format: int32
            viewers:
              type: integer
              description: >-
                The total number of unique viewers to download at least one
                chunk of the stream. A unique viewer is a single IP address;
                multiple users that share the same IP address are counted once.
              example: ''
              format: int32
            countries:
              type: object
              title: countries
              description: An array of viewer countries.
              properties:
                code:
                  type: string
                  description: A country code where the stream was requested.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            renditions:
              type: object
              title: renditions
              description: An array of viewer renditions.
              properties:
                name:
                  type: integer
                  description: >-
                    The rendition of the stream played. A rendition name is the
                    smaller number of the resolution. The resolution is
                    [width]x[height] in which the stream was played. Renditions
                    names have to be unique. If you've created two renditions
                    that have the same height and width, Wowza Video increments
                    the value of the height and uses that as the rendition name.


                    Example: Two renditions of 1280x720 will result in rendition
                    names of 720 and 721.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            devices:
              type: object
              title: devices
              description: An array of viewer devices.
              properties:
                name:
                  type: string
                  description: A device where the stream was played.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**. 
              example: ''
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        vod_stream:
          id: tvctq36g
          viewers: 7
          countries:
            - code: US
              viewers: 4
            - code: DE
              viewers: 3
          renditions:
            - name: 720
              viewers: 7
          devices:
            - name: Desktop
              viewers: 7
          time_zone: America/New_York
        limits:
          from: '2024-04-01T00:00:00.000Z'
          to: '2024-04-09T14:20:03.000Z'
    analytics_viewers_stream_target_total:
      type: object
      description: ''
      properties:
        stream_target:
          type: object
          title: stream_target
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the stream
                target.
              format: int32
            viewers:
              type: integer
              description: >-
                The total number of unique viewers to download at least one
                chunk of the stream. A unique viewer is a single IP address;
                multiple users that share the same IP address are counted once.
              example: ''
              format: int32
            countries:
              type: object
              title: countries
              description: An array of viewer countries.
              properties:
                code:
                  type: string
                  description: A country code where the stream was requested.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            renditions:
              type: object
              title: renditions
              description: An array of viewer renditions.
              properties:
                name:
                  type: integer
                  description: >-
                    The rendition of the stream played. A rendition name is the
                    smaller number of the resolution. The resolution is
                    [width]x[height] in which the stream was played. Renditions
                    names have to be unique. If you've created two renditions
                    that have the same height and width, Wowza Video increments
                    the value of the height and uses that as the rendition name.


                    Example: Two renditions of 1280x720 will result in rendition
                    names of 720 and 721.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            devices:
              type: object
              title: devices
              description: An array of viewer devices.
              properties:
                name:
                  type: string
                  description: A device where the stream was played.
                  example: ''
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers to download at least one
                    chunk of the stream. A unique viewer is a single IP address;
                    multiple users that share the same IP address are counted
                    once.
                  example: ''
                  format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**. 
              example: ''
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        stream_target:
          id: tvctq36g
          viewers: 7
          countries:
            - code: US
              viewers: 4
            - code: DE
              viewers: 3
          renditions:
            - name: 720
              viewers: 7
          devices:
            - name: Desktop
              viewers: 7
          time_zone: America/New_York
        limits:
          from: '2024-04-01T00:00:00.000Z'
          to: '2024-04-09T14:20:03.000Z'
    audio_codec_metric:
      type: object
      description: ''
      properties:
        status:
          type: string
          description: >-
            The status of the current key. Possible values are **normal**
            (everything is fine), **warning** (something may be misconfigured),
            and **no_data** (no data was returned, perhaps because the instance
            isn't running).
          example: normal
        text:
          type: string
          description: >-
            A message related to the value and status of the current key.
            Usually blank unless there's a warning status.
          example: ''
        units:
          type: string
          description: >-
            The unit of the returned value, such as **Kbps**, **bps**, **%**,
            **FPS**, or **GOP**.
          example: ''
        value:
          type: string
          description: The value of the associated key.
          example: aac
    bits_in_rate_metric:
      type: object
      description: ''
      properties:
        status:
          type: string
          description: >-
            The status of the current key. Possible values are **normal**
            (everything is fine), **warning** (something may be misconfigured),
            and **no_data** (no data was returned, perhaps because the instance
            isn't running).
          example: normal
        text:
          type: string
          description: >-
            A message related to the value and status of the current key.
            Usually blank unless there's a warning status.
          example: ''
        units:
          type: string
          description: >-
            The unit of the returned value, such as **Kbps**, **bps**, **%**,
            **FPS**, or **GOP**.
          example: Kbps
        value:
          type: number
          description: The value of the associated key.
          example: 317.3
          format: float
    bytes_in_rate_metric:
      type: object
      description: ''
      properties:
        status:
          type: string
          description: >-
            The status of the current key. Possible values are **normal**
            (everything is fine), **warning** (something may be misconfigured),
            and **no_data** (no data was returned, perhaps because the instance
            isn't running).
          example: normal
        text:
          type: string
          description: >-
            A message related to the value and status of the current key.
            Usually blank unless there's a warning status.
          example: ''
        units:
          type: string
          description: >-
            The unit of the returned value, such as **Kbps**, **bps**, **%**,
            **FPS**, or **GOP**.
          example: KBps
        value:
          type: number
          description: The value of the associated key.
          example: 317.3
          format: float
    connected_metric:
      type: object
      description: ''
      properties:
        status:
          type: string
          description: >-
            The status of the current key. Possible values are **normal**
            (everything is fine), **warning** (something may be misconfigured),
            and **no_data** (no data was returned, perhaps because the instance
            isn't running).
          example: normal
        text:
          type: string
          description: >-
            A message related to the value and status of the current key.
            Usually blank unless there's a warning status.
          example: ''
        units:
          type: string
          description: >-
            The unit of the returned value, such as **Kbps**, **bps**, **%**,
            **FPS**, or **GOP**.
          example: ''
        value:
          type: string
          description: The value of the associated key.
          example: 'Yes'
    frame_size_metric:
      type: object
      description: ''
      properties:
        status:
          type: string
          description: >-
            The status of the current key. Possible values are **normal**
            (everything is fine), **warning** (something may be misconfigured),
            and **no_data** (no data was returned, perhaps because the instance
            isn't running).
          example: warning
        text:
          type: string
          description: >-
            A message related to the value and status of the current key.
            Usually blank unless there's a warning status.
          example: >-
            Configured frame size is different from what Wowza Video is
            receiving from the source: 1280x720.
        units:
          type: string
          description: >-
            The unit of the returned value, such as **Kbps**, **bps**, **%**,
            **FPS**, or **GOP**.
          example: ''
        value:
          type: string
          description: The value of the associated key.
          example: 1280x720
    frame_rate_metric:
      type: object
      description: ''
      properties:
        status:
          type: string
          description: >-
            The status of the current key. Possible values are **normal**
            (everything is fine), **warning** (something may be misconfigured),
            and **no_data** (no data was returned, perhaps because the instance
            isn't running).
          example: normal
        text:
          type: string
          description: >-
            A message related to the value and status of the current key.
            Usually blank unless there's a warning status.
          example: ''
        units:
          type: string
          description: >-
            The unit of the returned value, such as **Kbps**, **bps**, **%**,
            **FPS**, or **GOP**.
          example: FPS
        value:
          type: integer
          description: The value of the associated key.
          example: 30
    height_metric:
      type: object
      description: ''
      properties:
        status:
          type: string
          description: >-
            The status of the current key. Possible values are **normal**
            (everything is fine), **warning** (something may be misconfigured),
            and **no_data** (no data was returned, perhaps because the instance
            isn't running).
          example: warning
        text:
          type: string
          description: >-
            A message related to the value and status of the current key.
            Usually blank unless there's a warning status.
          example: >-
            Configured height is different from what Wowza Video is receiving
            from the source: 720.
        units:
          type: string
          description: >-
            The unit of the returned value, such as **Kbps**, **bps**, **%**,
            **FPS**, or **GOP**.
          example: px
        value:
          type: integer
          description: The value of the associated key.
          example: 720
    keyframe_interval_metric:
      type: object
      description: ''
      properties:
        status:
          type: string
          description: >-
            The status of the current key. Possible values are **normal**
            (everything is fine), **warning** (something may be misconfigured),
            and **no_data** (no data was returned, perhaps because the instance
            isn't running).
          example: normal
        text:
          type: string
          description: >-
            A message related to the value and status of the current key.
            Usually blank unless there's a warning status.
          example: ''
        units:
          type: string
          description: >-
            The unit of the returned value, such as **Kbps**, **bps**, **%**,
            **FPS**, or **GOP**.
          example: GOP
        value:
          type: integer
          description: The value of the associated key.
          example: 69
    video_codec_metric:
      type: object
      description: ''
      properties:
        status:
          type: string
          description: >-
            The status of the current key. Possible values are **normal**
            (everything is fine), **warning** (something may be misconfigured),
            and **no_data** (no data was returned, perhaps because the instance
            isn't running).
          example: normal
        text:
          type: string
          description: >-
            A message related to the value and status of the current key.
            Usually blank unless there's a warning status.
          example: ''
        units:
          type: string
          description: >-
            The unit of the returned value, such as **Kbps**, **bps**, **%**,
            **FPS**, or **GOP**.
          example: ''
        value:
          type: string
          description: >-
            The value of the associated key.


            <blockquote>Note: You might see avc1 or h264 returned
            interchangeably.</blockquote>
          example: h264
    width_metric:
      type: object
      description: ''
      properties:
        status:
          type: string
          description: >-
            The status of the current key. Possible values are **normal**
            (everything is fine), **warning** (something may be misconfigured),
            and **no_data** (no data was returned, perhaps because the instance
            isn't running).
          example: warning
        text:
          type: string
          description: >-
            A message related to the value and status of the current key.
            Usually blank unless there's a warning status.
          example: >-
            Configured width is different from what Wowza Video is receiving
            from the source: 1280.
        units:
          type: string
          description: >-
            The unit of the returned value, such as **Kbps**, **bps**, **%**,
            **FPS**, or **GOP**.
          example: px
        value:
          type: integer
          description: The value of the associated key.
          example: 1280
    trend_metric:
      type: object
      description: |-
        An array of viewer trend data.
        > **Note:** This parameter only returns data for Fastly stream targets.
      properties:
        bits_in_rate:
          type: integer
          description: The rate at which data is processed in.
          example: ''
        created_at:
          type: string
          description: The date and time that the trend was created.
          example: ''
        frame_rate:
          type: integer
          description: The number of frames that appear in a second.
          example: ''
        height:
          type: integer
          description: The height of the video player, in pixels.
          example: ''
        keyframe_interval:
          type: integer
          description: >-
            An encoding setting that determines how often the whole picture is
            transmitted.
          example: ''
        width:
          type: integer
          description: The width of the video player, in pixels.
          example: ''
      example:
        - bits_in_rate: 1030123
          created_at: '2023-03-30T22:42:57Z'
          frame_rate: 30
          height: 288
          keyframe_interval: 60
          width: 512
        - bits_in_rate: 866928
          created_at: '2023-03-30T22:42:58Z'
          frame_rate: 30
          height: 288
          keyframe_interval: 60
          width: 512
    limits_metric:
      type: object
      description: The time frame represented in the response.
      properties:
        from:
          type: string
          description: The start of the range of time represented in the response.
          example: '2024-03-14T10:31:54.000Z'
          format: date-time
        to:
          type: string
          description: The end of the range of time represented in the response.
          example: '2024-04-13T10:31:54.000Z'
          format: date-time
    analytics_ingest_live_stream:
      type: object
      description: ''
      properties:
        live_stream:
          type: object
          title: live_stream
          description: ''
          properties:
            id:
              type: string
              description: The unique alphanumeric string that identifies the live stream.
              example: tvctq36g
              format: int32
            audio_codec:
              $ref: '#/components/schemas/audio_codec_metric'
            bits_in_rate:
              $ref: '#/components/schemas/bits_in_rate_metric'
            bytes_in_rate:
              $ref: '#/components/schemas/bytes_in_rate_metric'
            connected:
              $ref: '#/components/schemas/connected_metric'
            frame_size:
              $ref: '#/components/schemas/frame_size_metric'
            frame_rate:
              $ref: '#/components/schemas/frame_rate_metric'
            height:
              $ref: '#/components/schemas/height_metric'
            keyframe_interval:
              $ref: '#/components/schemas/keyframe_interval_metric'
            video_codec:
              $ref: '#/components/schemas/video_codec_metric'
            width:
              $ref: '#/components/schemas/width_metric'
            stream_target_status:
              type: array
              description: An array of stream_target_status data.
              items:
                type: object
                title: stream_target_status
                properties:
                  status:
                    type: string
                    description: >-
                      The status of the current key. Possible values are
                      **normal** (everything is fine), **warning** (something
                      may be misconfigured), and **no_data** (no data was
                      returned, perhaps because the instance isn't running).
                    example: normal
                  text:
                    type: string
                    description: >-
                      A message related to the value and status of the current
                      key. Usually blank unless there's a warning status.
                    example: ''
                  units:
                    type: string
                    description: >-
                      The unit of the returned value, such as **Kbps**, **bps**,
                      **%**, **FPS**, or **GOP**.
                    example: ''
                  value:
                    type: integer
                    description: The value of the associated key.
                    example: Active
                  id:
                    type: string
                    description: >-
                      The unique alphanumeric string that identifies the
                      stream_target_status. This ID id created by combining the
                      output ID and stream target ID as
                      OUTPUTIDX_STREAMTARGETIDX.
                    example: 3lftlf1r_fcm6d98
            trend:
              $ref: '#/components/schemas/trend_metric'
        limits:
          $ref: '#/components/schemas/limits_metric'
    usage_account:
      type: object
      description: ''
      properties:
        account:
          type: object
          title: account
          description: Data for the account.
          properties:
            id:
              type: string
              description: The unique alphanumeric string that identifies an account.
              example: ''
              format: int32
            viewing_seconds:
              type: integer
              description: >-
                The total length of time, in seconds, that the stream was played
                at the target. May be longer than the duration of the stream.
              example: ''
              format: int32
            viewing_bytes:
              type: integer
              description: >-
                The amount of content, in bytes, that went through the stream
                target during the selected time frame.
              example: ''
              format: int32
            egress_seconds:
              type: integer
              description: >-
                The length of time, in seconds, that Wowza CDN on Fastly pulled
                from storage during the selected time frame.
              example: ''
              format: int32
            egress_seconds_additional_targets:
              type: integer
              description: >-
                The length of time, in seconds, that additional stream targets
                pulled from storage during the selected time frame.
                Subscriptions prices include egress for one target; additional
                targets incur additional charges.
              example: ''
              format: int32
            egress_bytes:
              type: integer
              description: >-
                The amount of content, in bytes, that Wowza CDN on Fastly pulled
                from storage during the selected time frame.
              example: ''
              format: int32
            trend:
              type: object
              title: Array of viewer trends
              description: >-
                An array of viewer trend data. The granularity of sampled data
                changes based on the from and to query values you use:


                Requests made for data within the past 30 days, return the
                following sample intervals: <ul><li>0 minutes to 3 hours -
                Samples returned per minute</li> <li>3 hours, 1 second to 24
                hours - Samples returned per hour</li> <li>24 hours, 1 second to
                90 days - Samples returned per day</li></ul>


                <strong>Defaults</strong>: from = last billing date, to = end of
                current day
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                viewing_seconds:
                  type: integer
                  description: >-
                    The total length of time, in seconds, that the stream was
                    played at the target. May be longer than the duration of the
                    stream.
                  example: ''
                  format: int32
                viewing_bytes:
                  type: integer
                  description: >-
                    The amount of content, in bytes, that went through the
                    transcoder during the selected time frame.
                  example: ''
                  format: int32
        limits:
          type: object
          description: The query parameters applied to the request.
          properties:
            resources:
              type: object
              title: resources
              description: The resources represented in the response.
              properties:
                transcoders:
                  type: string
                  description: The response includes transcoders.
                  example: ''
                vod_streams:
                  type: string
                  description: The response includes VOD streams.
                  example: ''
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        account:
          id: rfP7rDv2
          viewing_seconds: 44925498
          avg_viewing_seconds: 2634
          viewing_bytes: 22886
          egress_seconds: 49549
          egress_seconds_additional_targets: 345
          egress_bytes: 7066810
          trend:
            - sampled_at: '2019-10-01T08:00:00.000Z'
              viewing_seconds: 45
              viewing_bytes: 20
        limits:
          resources:
            - transcoders
            - vod_streams
          from: '2021-01-07T00:00:00.000Z'
          to: '2021-10-05T00:00:00.000Z'
    analytics_engagement_vod_stream:
      type: object
      description: ''
      properties:
        vod_stream:
          type: object
          title: vod_stream
          description: ''
          properties:
            id:
              type: string
              description: The unique alphanumeric string that identifies the VOD stream.
              format: int32
            play_rate:
              type: integer
              description: >-
                The ratio between displays and plays. For example, 100 displays
                and 20 plays will result in 0.20 which means that 20% of the
                displays resulted in a play.
              example: ''
              format: int32
            completion_rate:
              type: integer
              description: >-
                The ratio of viewers that watched the last segment of the asset.
                It is represented in a decimal value.
              example: ''
            duration_ms:
              type: integer
              description: The length of the stream in milliseconds.
              example: ''
            avg_seconds_watched:
              type: integer
              description: The average number of seconds the viewers viewed the stream.
              example: ''
            avg_percentage_watched:
              type: integer
              description: The average time watched represented as a percentage.
              example: ''
            total_seconds_watched:
              type: integer
              description: The total number of seconds the stream was viewed.
              example: ''
            trend:
              type: object
              title: Array of viewer trends
              description: >-
                An array of viewer trend data for an asset in the given time
                period.


                 <blockquote>Note: Data from the most recent hour data might not be included in the result of a time range that extends beyond the most recent 3 days. </blockquote>


                <strong>Default</strong>: Last hour
              properties:
                percent:
                  type: integer
                  description: >-
                    A specific segment of the VOD asset. A VOD asset has 100
                    segments and each segment represents a completion percentage
                    of the asset. For example, 1 is the data for 0 to 1% of the
                    asset, 2 is the data for 1 to 2% and so on.


                    Trend data is aggregated for each segment.


                    Use _**duration_ms** / 1000 x **percent**_ to calculate a
                    timestamp, in seconds, for the trend data.
                  format: int32
                viewers:
                  type: integer
                  description: >-
                    The total number of unique viewers who watched this specific
                    segment of the VOD asset. A unique viewer is a single IP
                    address; multiple users that share the same IP address are
                    counted once.
                  example: ''
                  format: int32
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        vod_stream:
          id: tvctq36g
          play_rate: 0.2
          completion_rate: 0.42
          duration_ms: 9761000
          avg_seconds_watched: 302
          avg_percentage_watched: 67
          total_seconds_watched: 77699
          trend:
            - percent: 1
              viewers: 7
            - percent: 2
              viewers: 7
            - percent: 3
              viewers: 7
            - percent: 4
              viewers: 7
            - percent: 5
              viewers: 10
            - percent: 6
              viewers: 7
            - percent: 7
              viewers: 7
            - percent: 8
              viewers: 25
            - percent: 9
              viewers: 25
            - percent: 10
              viewers: 25
            - percent: 11
              viewers: 7
            - spercent: 12
              viewers: 7
            - percent: 13
              viewers: 7
        limits:
          from: '2024-03-14T10:31:54.000Z'
          to: '2024-04-13T10:31:54.000Z'
    analytics_popularity_live_stream:
      type: object
      description: ''
      properties:
        live_stream:
          type: object
          title: live_stream
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the live stream
                or real-time stream.
              format: int32
            plays:
              type: integer
              description: >-
                The total number of plays for a stream. A play is registered
                when the stream begins to play.
              example: ''
              format: int32
            displays:
              type: integer
              description: >-
                The total number of displays for a stream. A display is
                registered when the player is completely loaded and ready to
                play the stream.
              example: ''
              format: int32
            trend:
              type: object
              title: Array of popularity trends
              description: >-
                An array of popularity trend data. The granularity of sampled
                data changes based on the from and to query values you use:


                1. Requests made for data _within_ the most recent 3 days
                returns sample intervals by the hour. You can return sample
                intervals by the minute by specifying a specific hour range.


                2. Requests made for data _beyond_ the most recent 3 days can
                only return sample intervals by the hour or day. The minute data
                is not retained beyond the 3rd day. 


                 <blockquote>Note: Data from the most recent hour data might not be included in the result of a time range that extends beyond the most recent 3 days. </blockquote>


                <strong>Default</strong>: Last hour
              properties:
                plays:
                  type: integer
                  description: >-
                    The total number of plays for a stream at the time the trend
                    data was sampled. A play is registered when the stream
                    begins to play.
                  example: ''
                  format: int32
                displays:
                  type: integer
                  description: >-
                    The total number of displays for a stream at the time the
                    trend data was sampled. A display is registered when the
                    player is completely loaded and ready to play the stream.
                  example: ''
                  format: int32
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        live_stream:
          id: tvctq36g
          plays: 2
          displays: 2
          trend:
            - plays: 1
              displays: 1
              sampled_at: '2023-05-26T12:01:00Z'
            - plays: 1
              displays: 1
              sampled_at: '2023-05-26T12:02:00Z'
        limits:
          from: '2024-03-14T10:31:54.000Z'
          to: '2024-04-13T10:31:54.000Z'
    analytics_popularity_vod_stream:
      type: object
      description: ''
      properties:
        vod_stream:
          type: object
          title: vod_stream
          description: ''
          properties:
            id:
              type: string
              description: The unique alphanumeric string that identifies the VOD stream.
              format: int32
            plays:
              type: integer
              description: >-
                The total number of plays for a VOD stream. A play is registered
                when the stream begins to play.
              example: ''
              format: int32
            displays:
              type: integer
              description: >-
                The total number of displays for a VOD stream. A display is
                registered when the player is completely loaded and ready to
                play the VOD stream.
              example: ''
              format: int32
            trend:
              type: object
              title: Array of popularity trends
              description: >-
                An array of popularity trend data. The granularity of sampled
                data changes based on the from and to query values you use:


                1. Requests made for data _within_ the most recent 3 days
                returns sample intervals by the hour. You can return sample
                intervals by the minute by specifying a specific hour range.


                2. Requests made for data _beyond_ the most recent 3 days can
                only return sample intervals by the hour or day. The minute data
                is not retained beyond the 3rd day. 


                 <blockquote>Note: Data from the most recent hour data might not be included in the result of a time range that extends beyond the most recent 3 days. </blockquote>



                <strong>Default</strong>: Last hour
              properties:
                plays:
                  type: integer
                  description: >-
                    The total number of plays for a VOD stream at the time the
                    trend data was sampled. A play is registered when the stream
                    begins to play.
                  example: ''
                  format: int32
                displays:
                  type: integer
                  description: >-
                    The total number of displays for a VOD stream at the time
                    the trend data was sampled. A display is registered when the
                    player is completely loaded and ready to play the VOD
                    stream. 
                  example: ''
                  format: int32
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        vod_stream:
          id: tvctq36g
          plays: 2
          displays: 2
          trend:
            - plays: 1
              displays: 1
              sampled_at: '2023-05-26T12:01:00Z'
            - plays: 1
              displays: 1
              sampled_at: '2023-05-26T12:02:00Z'
        limits:
          from: '2024-03-14T10:31:54.000Z'
          to: '2024-04-13T10:31:54.000Z'
    analytics_qoe_error_density_account:
      type: object
      description: ''
      properties:
        account:
          type: object
          title: account
          description: ''
          properties:
            error_density:
              type: integer
              description: >-
                The average number of playback errors per playback start. A
                playback start includes the initial start of a stream as well as
                any resume events after rebuffering or user-initiated pauses.
                For example, if there are 1000 total playback errors across 500
                play sessions, the error density would be 2.
              example: ''
              format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
            trend:
              type: object
              title: Array of error density trends
              description: >-
                An array of error density trend data. The granularity of sampled
                data changes based on the from and to query values you use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                error_density:
                  type: integer
                  description: The percentage of errors encountered during video playback.
                  example: ''
                  format: int32
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        account:
          error_density: 7
          time_zone: America/New_York
          trend:
            - average: 1.0,
              sampled_at: '2024-09-08T00:00:00+00:00'
            - average: 0.9829059829059829,
              sampled_at: '2024-09-11T00:00:00+00:00'
            - average: 0.806060606060606,
              sampled_at: '2024-09-13T00:00:00+00:00'
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_error_density_media_{id}:
      type: object
      description: ''
      properties:
        media:
          type: object
          title: media
          description: ''
          properties:
            error_density:
              type: integer
              description: >-
                The average number of playback errors per playback start. A
                playback start includes the initial start of a stream as well as
                any resume events after rebuffering or user-initiated pauses.
                For example, if there are 1000 total playback errors across 500
                play sessions, the error density would be 2.
              format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
            trend:
              type: object
              title: Array of error density trends
              description: >-
                An array of error density trend data. The granularity of sampled
                data changes based on the from and to query values you use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                error_density:
                  type: integer
                  description: >-
                    The percentage of plays that encountered issues during
                    playback.
                  example: ''
                  format: int32
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        media:
          error_density: 7
          time_zone: America/New_York
          trend:
            - average: 1.0,
              sampled_at: '2024-09-08T00:00:00+00:00'
            - average: 0.9829059829059829,
              sampled_at: '2024-09-11T00:00:00+00:00'
            - average: 0.806060606060606,
              sampled_at: '2024-09-13T00:00:00+00:00'
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_error_free_sessions_account:
      type: object
      description: ''
      properties:
        account:
          type: object
          title: account
          description: ''
          properties:
            error_free_sessions:
              type: integer
              description: >-
                The percentage of sessions with no fatal errors across any
                stream before or during playback. A session is considered
                error-free if no fatal errors occur at any time, either before
                or during playback.


                **Note:** The value for error-free sessions will be 100% if
                there is no playback activity during the specified time range,
                as no errors would have occurred.  
              example: ''
              format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
            trend:
              type: object
              title: Array of error free sessions
              description: >-
                An array of error free sessions trend data. The granularity of
                sampled data changes based on the from and to query values you
                use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                average:
                  type: integer
                  description: >-
                    The average percentage of error free sessions encountered
                    during video playback.
                  example: ''
                  format: int32
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        account:
          error_free_sessions: 7
          time_zone: America/New_York
          trend:
            - average: 1.0,
              sampled_at: '2024-09-08T00:00:00+00:00'
            - average: 2.0,
              sampled_at: '2024-09-11T00:00:00+00:00'
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_error_free_sessions_media_media_ids:
      type: object
      description: ''
      properties:
        account:
          type: object
          title: media
          description: ''
          properties:
            error_free_sessions:
              type: integer
              description: >-
                The percentage of sessions with no fatal errors across any
                stream before or during playback. A session is considered
                error-free if no fatal errors occur at any time, either before
                or during playback.


                **Note:** The value for error-free sessions will be 100% if
                there is no playback activity during the specified time range,
                as no errors would have occurred.
              example: ''
              format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
            trend:
              type: object
              title: Array of error free sessions
              description: >-
                An array of error free sessions trend data. The granularity of
                sampled data changes based on the from and to query values you
                use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                average:
                  type: integer
                  description: >-
                    The average percentage of error free sessions encountered
                    during video playback.
                  example: ''
                  format: int32
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        media:
          error_free_sessions: 7
          time_zone: America/New_York
          trend:
            - average: 1.0,
              sampled_at: '2024-09-08T00:00:00+00:00'
            - average: 2.0,
              sampled_at: '2024-09-11T00:00:00+00:00'
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_errors_drilldown:
      type: object
      description: ''
      properties:
        error:
          type: object
          title: Error
          description: ''
          properties:
            code:
              type: string
              description: >-
                The error code ID. For a full list of the player error codes,
                see this <a
                href="https://try.flowplayer.com/?channel=stable#0=N4Igtglg...">list</a>.
              example: 02-01
            name:
              type: string
              description: The name of the playback error.
              example: PlaybackVideoBufferUnderRun
            type:
              type: string
              description: The type of event related to video/audio streaming.
              example: Playback
            avg_retry_count:
              type: number
              format: float
              description: The average number of retry attempts for the error.
              example: 0.92
            total_count:
              type: integer
              description: The total number of times the error occurred in the timeframe.
              example: 10
            session_count:
              type: integer
              description: The number of unique sessions in which the error occurred.
              example: 2
            trend:
              type: array
              title: Array of error density trends
              description: >-
                An array of error density trend data. The granularity of sampled
                data changes based on the from and to query values you use:

                <ul>
                  <li>0 minutes to 8 hours - Samples returned per minute</li>
                  <li>8 hours, 1 second to 24 hours - Samples returned per hour</li>
                  <li>24 hours, 1 second to 175 days - Samples returned per day</li>
                  <li>175 days to 14 years - Samples returned per month</li>
                  <li>14 years or greater - Samples returned per year</li>
                </ul>
              items:
                type: object
                properties:
                  sampled_at:
                    type: string
                    format: date-time
                    description: The date and time the trend data was sampled.
                    example: '2024-09-08T14:35:00.000Z'
                  count:
                    type: integer
                    description: >-
                      The number of times this specific error occurred at that
                      time.
                    example: 3
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              format: date-time
              description: The start of the range of time represented in the response.
              example: '2024-09-08T14:35:00.000Z'
            to:
              type: string
              format: date-time
              description: The end of the range of time represented in the response.
              example: '2024-10-08T14:35:00.000Z'
            limit:
              type: integer
              description: The maximum number of results returned per page.
              example: 10
            page:
              type: integer
              description: The current page number of the response.
              example: 0
            max_page:
              type: integer
              description: The maximum number of available pages.
              example: 0
      example:
        error:
          - code: 02-01
            avg_retry_count: 0.92
            total_count: 10
            session_count: 2
            name: PlaybackVideoBufferUnderRun
            type: Playback
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
          limit: 10
          page: 0
          max_page: 0
    analytics_qoe_errors_drilldown_trend_error_code:
      type: object
      description: ''
      properties:
        error:
          type: object
          title: error
          description: ''
          properties:
            code:
              type: string
              description: >-
                The error code id. For a full list of the player error codes,
                see this <a href=
                "https://try.flowplayer.com/?channel=stable#0=N4IgtglgJlA2CmIBcBWADAGhAZ3ggxgC7xTIgB0+22IW+A9rPQE5nMDmARgBQDMAHBnRCAbAEpaIQgAt4YREnABDYswhLYAWgAOG+ADsI7aYUmwlAT3oBXU4qW36k5vGwQAXvCWcEyQs2t4LBIIQm9fJH9ArEJ6Rk4lVkiAoJAAMwgEABVvGmTokFgIfQBrHM48qNTsaUT4ACFbWP0-FKwXJiUoRsJm1oKGfWxGBSqsB1iAJTx6Lv7UifppzqgAETxLZAAWNEwQRYAxenxrPLSNXHHHAAl4IxNkc9hLnHxmRlhkAG1MNABdLAZBB5L6gfRKeRkbQuABuEHgAHdJINiPo7CAQABfDBgiEKKT0EoGcgAKxodHoaIM6IRxSg9AR5AA+kyDgAZADyAHUAApsgCCAE0AKKTJlZDkAaWFADkALwAHRA8AsAClmEouQBFCAciCqrUAZRJUBlxukKCg7gAsrwtWB+BA2QBhVVoeAADX5uv1koAagBGHUu1XSTgAcXwPtVBwAqu4AJIBmX6gCc5BVqpJCZJ9HhAdpgq5MuwHudCZEKYAHvgE2BYCUyxWywbjabzZabXawKna-o0E7Xdp8LxrdHwxHU7x8OGq7IuX6LAn++Q-arrtd9F5w4bw6sufRBcwtiJDfh+at2Ch6uH+WhrvzmPxDbwPVlVQAmNLsNn0VOaGVCAALX4bRDQ-EQPTCLUSnwVN6Hqa4uWgcwIAgKt6GkfhhWYBEoGYElrQ5egPy1epJQRJUAG5JGkaAoAMeZsVxSFFFJckQBRakyA5TgSXgIgMzRNRXG4NImARbRzAseBmAzZh3mYbAxHINIWGFJR8GkbhuC+IkLAwAACBgGL+MQ5QAPkM4AFX0QzjMpbBCEM-ThQQOVDPpE55DRSgXBUeA3LkaluCVbBdH0JUxFs+zBichyGKCwyPK86wfMIPyvGIIL0tCnAIqimKHKGZywh8eBks8440upch2HgQgcupeolygPLZMUzQTNcQq7JclUgvIYgq0IZ1KVRZyPP0orusG4bRvG6lKu6oqyoQcglG0bQDDa1yECM2aEGi-RMQkLBcAIQgIEcsgUCQD9+CxHEQHBViKCoDiuLRMgAGIOpYLr6AY7BrKKqAIHC6SkEM9g1CgKiith6BNGIMApICwHYDSoZoYDNJmEMvHmCowyAHoACpDOFABHawNEM2koBkBysbAIZDPJ0nEc26GPzQbQqxJinDMNXR8AqzgGoReADBZ7GQc52zMUkC6BKum7FF4e60Celj8XIEx62RRbvsUWyAB5wZhQzoEVZUFIB7rsCVCyiot0mrYslW8DV66hjIAMkC2LEAUKYoShBUBCAsbayCcixfCwV78U4IGLEkaxmE+RQTEIbRsCQUnSf8CxVIk9GZLkhgwFJgI0QgeRNCgRISkoahaPoxj8ngZiXrxMh6BhbQM6zshc-zwvSfwKB9DLhkK9kyh6BrjovFwbBSfBK6YXgUneFJpzwl3qTrHYYoN8H7RyEgWeyUkaPY8UbA3ggbRTCwOiYC7qpe+TsfnhHtnEA48C5F2nrPcS89pKL2rrXH2Sh16bxUBAHee8D5rWPljM+QxSbSGeNfYo7F74x3xM-NQb8O5fxaN3X+-dFCQMktA1gWBM5AJAZPcBc9GGWBgcvOBCAEGuCQdvXe+9D7lQ9vAc41hYCEFJgwheckb5EJiCQuOL8KEf07tQn+z0-70PLkwtuHFWFj16BPMBM8uGKKXiveBiCt4oNEego+6CE67wUUYj6xDH44GjonYB2imJ-ExEAA">list</a>.
              example: ''
            trend:
              type: object
              title: Array of error density trends
              description: >-
                An array of error density trend data. The granularity of sampled
                data changes based on the from and to query values you use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                count:
                  type: integer
                  description: >-
                    The total number of times this specific error occurred at
                    the sampled time.
                  example: ''
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
            name:
              type: string
              description: The name of the playback error.
              example: ''
            type:
              type: string
              description: The type of event related to video/audio streaming.
              example: ''
      example:
        error:
          - code: 02-01
            trend: null
            count: 10
            sampled_at: '2024-09-19T00:00:00Z'
            name: PlaybackVideoBufferUnderRun
            type: Playback
            limits:
              from: '2024-09-08T14:35:00.000Z'
              to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_errors_detail_media_error_code:
      type: object
      description: Error drilldown metrics by media
      properties:
        code:
          type: string
          description: The error code associated with the playback issue.
          example: 02-01
        name:
          type: string
          description: The name of the playback error.
          example: PlaybackVideoBufferUnderRun
        type:
          type: string
          description: The type of media event associated with the error.
          example: Media
        media:
          type: array
          description: An array of media items where the error occurred.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier for the media.
                example: abcd1234
              playback_type:
                type: string
                description: Type of playback for the media (e.g., live, VOD).
                example: VOD
              count:
                type: integer
                description: Number of times the error occurred for this media.
                example: 5
        limits:
          type: object
          description: The time range and pagination for the returned results.
          properties:
            from:
              type: string
              format: date-time
              description: The start of the time range for the results.
              example: '2024-09-08T00:00:00Z'
            to:
              type: string
              format: date-time
              description: The end of the time range for the results.
              example: '2024-10-08T00:00:00Z'
            limit:
              type: integer
              description: The maximum number of results returned per page.
              example: 10
            page:
              type: integer
              description: The current page of results.
              example: 0
            max_page:
              type: integer
              description: The maximum number of available pages.
              example: 10
      example:
        code: 02-01
        name: PlaybackVideoBufferUnderRun
        type: Media
        media:
          - id: abcd1234
            playback_type: VOD
            count: 5
        limits:
          from: '2024-09-08T00:00:00Z'
          to: '2024-10-08T00:00:00Z'
          limit: 10
          page: 0
          max_page: 10
    analytics_qoe_errors_detail_message_error_code:
      type: object
      description: Error drilldown metrics by error message
      properties:
        code:
          type: string
          description: The error code associated with the playback issue.
          example: 02-01
        name:
          type: string
          description: The name of the playback error.
          example: PlaybackVideoBufferUnderRun
        type:
          type: string
          description: The type of media event associated with the error.
          example: Media
        message:
          type: array
          description: An array of error messages and their associated counts.
          items:
            type: object
            properties:
              text:
                type: string
                description: The specific error message text.
                example: Buffer underrun occurred during playback
              count:
                type: integer
                description: Number of times this specific error message occurred.
                example: 7
        limits:
          type: object
          description: The time range and pagination for the returned results.
          properties:
            from:
              type: string
              format: date-time
              description: The start of the time range for the results.
              example: '2024-09-08T00:00:00Z'
            to:
              type: string
              format: date-time
              description: The end of the time range for the results.
              example: '2024-10-08T00:00:00Z'
            limit:
              type: integer
              description: The maximum number of results returned per page.
              example: 10
            page:
              type: integer
              description: The current page of results.
              example: 0
            max_page:
              type: integer
              description: The maximum number of available pages.
              example: 10
      example:
        code: 02-01
        name: PlaybackVideoBufferUnderRun
        type: Media
        message:
          - text: Buffer underrun occurred during playback
            count: 7
        limits:
          from: '2024-09-08T00:00:00Z'
          to: '2024-10-08T00:00:00Z'
          limit: 10
          page: 0
          max_page: 10
    analytics_qoe_errors_detail_resources_error_code:
      type: object
      description: ''
      properties:
        code:
          type: string
          description: >-
            The error code id. For a full list of the player error codes, see
            this <a href=
            "https://try.flowplayer.com/?channel=stable#0=N4IgtglgJlA2CmIBcBWADAGhAZ3ggxgC7xTIgB0+22IW+A9rPQE5nMDmARgBQDMAHBnRCAbAEpaIQgAt4YREnABDYswhLYAWgAOG+ADsI7aYUmwlAT3oBXU4qW36k5vGwQAXvCWcEyQs2t4LBIIQm9fJH9ArEJ6Rk4lVkiAoJAAMwgEABVvGmTokFgIfQBrHM48qNTsaUT4ACFbWP0-FKwXJiUoRsJm1oKGfWxGBSqsB1iAJTx6Lv7UifppzqgAETxLZAAWNEwQRYAxenxrPLSNXHHHAAl4IxNkc9hLnHxmRlhkAG1MNABdLAZBB5L6gfRKeRkbQuABuEHgAHdJINiPo7CAQABfDBgiEKKT0EoGcgAKxodHoaIM6IRxSg9AR5AA+kyDgAZADyAHUAApsgCCAE0AKKTJlZDkAaWFADkALwAHRA8AsAClmEouQBFCAciCqrUAZRJUBlxukKCg7gAsrwtWB+BA2QBhVVoeAADX5uv1koAagBGHUu1XSTgAcXwPtVBwAqu4AJIBmX6gCc5BVqpJCZJ9HhAdpgq5MuwHudCZEKYAHvgE2BYCUyxWywbjabzZabXawKna-o0E7Xdp8LxrdHwxHU7x8OGq7IuX6LAn++Q-arrtd9F5w4bw6sufRBcwtiJDfh+at2Ch6uH+WhrvzmPxDbwPVlVQAmNLsNn0VOaGVCAALX4bRDQ-EQPTCLUSnwVN6Hqa4uWgcwIAgKt6GkfhhWYBEoGYElrQ5egPy1epJQRJUAG5JGkaAoAMeZsVxSFFFJckQBRakyA5TgSXgIgMzRNRXG4NImARbRzAseBmAzZh3mYbAxHINIWGFJR8GkbhuC+IkLAwAACBgGL+MQ5QAPkM4AFX0QzjMpbBCEM-ThQQOVDPpE55DRSgXBUeA3LkaluCVbBdH0JUxFs+zBichyGKCwyPK86wfMIPyvGIIL0tCnAIqimKHKGZywh8eBks8440upch2HgQgcupeolygPLZMUzQTNcQq7JclUgvIYgq0IZ1KVRZyPP0orusG4bRvG6lKu6oqyoQcglG0bQDDa1yECM2aEGi-RMQkLBcAIQgIEcsgUCQD9+CxHEQHBViKCoDiuLRMgAGIOpYLr6AY7BrKKqAIHC6SkEM9g1CgKiith6BNGIMApICwHYDSoZoYDNJmEMvHmCowyAHoACpDOFABHawNEM2koBkBysbAIZDPJ0nEc26GPzQbQqxJinDMNXR8AqzgGoReADBZ7GQc52zMUkC6BKum7FF4e60Celj8XIEx62RRbvsUWyAB5wZhQzoEVZUFIB7rsCVCyiot0mrYslW8DV66hjIAMkC2LEAUKYoShBUBCAsbayCcixfCwV78U4IGLEkaxmE+RQTEIbRsCQUnSf8CxVIk9GZLkhgwFJgI0QgeRNCgRISkoahaPoxj8ngZiXrxMh6BhbQM6zshc-zwvSfwKB9DLhkK9kyh6BrjovFwbBSfBK6YXgUneFJpzwl3qTrHYYoN8H7RyEgWeyUkaPY8UbA3ggbRTCwOiYC7qpe+TsfnhHtnEA48C5F2nrPcS89pKL2rrXH2Sh16bxUBAHee8D5rWPljM+QxSbSGeNfYo7F74x3xM-NQb8O5fxaN3X+-dFCQMktA1gWBM5AJAZPcBc9GGWBgcvOBCAEGuCQdvXe+9D7lQ9vAc41hYCEFJgwheckb5EJiCQuOL8KEf07tQn+z0-70PLkwtuHFWFj16BPMBM8uGKKXiveBiCt4oNEego+6CE67wUUYj6xDH44GjonYB2imJ-ExEAA">list</a>.
        resource:
          type: object
          title: resource
          description: ''
          properties:
            url:
              type: string
              description: The URL associated with a specific error code.
              example: ''
            count:
              type: integer
              description: >-
                Total number of times this specific error occurred for the
                media.
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
                page:
                  type: integer
                  description: >-
                    Returns a paginated view of results. A positive integer
                    indicates which page of the results are displayed. The
                    default is **0**.


                    - If page=0, rows 1-10 are returned.

                    - If page=1, rows 11-20 are returned.
                  example: ''
                  format: int32
                limit:
                  type: integer
                  description: >-
                    The number of results returned per page. The maximum number
                    of results per page is 20. The default is **10**.
                  example: ''
                  format: int32
                max_page:
                  type: integer
                  description: The maximum number of pages that will be returned.
                  example: ''
                  format: int32
            name:
              type: string
              description: The name of the playback error.
              example: ''
            type:
              type: string
              description: The type of event related to video/audio streaming.
              example: ''
      example:
        code: 02-01
        resource:
          url: https://www.w3schools.com/html/mov_bbb.mp4
          count: 10
        name: PlaybackVideoBufferUnderRun
        type: Playback
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_rebuffer_count_account:
      type: object
      description: ''
      properties:
        account:
          type: object
          title: account
          description: ''
          properties:
            rebuffer_per_view:
              type: integer
              description: >-
                The average number of rebuffer events per view. rebuffer events
                can be the pauses to load or buffer additional data experienced
                during playback.
              example: ''
              format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
            trend:
              type: object
              title: Array of rebuffer count trends
              description: >-
                An array of rebuffer count trend data. The granularity of
                sampled data changes based on the from and to query values you
                use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                error_density:
                  type: integer
                  description: The percentage of errors encountered during video playback.
                  example: ''
                  format: int32
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        account:
          rebuffer_per_view: 0.009584664536741214
          time_zone: Etc/UTC
          trend:
            - average: 0.0,
              sampled_at: '2024-09-08T00:00:00+00:00'
            - average: 0.01171875,
              sampled_at: '2024-09-11T00:00:00+00:00'
            - average: 0.0,
              sampled_at: '2024-09-13T00:00:00+00:00'
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_rebuffer_count_media_id:
      type: object
      description: ''
      properties:
        media:
          type: object
          title: media
          description: ''
          properties:
            rebuffer_per_view:
              type: number
              description: >-
                The average number of rebuffer events per each play. rebuffer
                events can be the pauses to load or buffer additional data
                experienced during playback. 
              example: ''
              format: float
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
            trend:
              type: object
              title: Array of rebuffer count trends
              description: >-
                An array of rebuffer count trend data. The granularity of
                sampled data changes based on the from and to query values you
                use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                error_density:
                  type: number
                  description: The percentage of errors encountered during video playback.
                  example: ''
                  format: float
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        media:
          rebuffer_per_view: 0
          time_zone: America/New_York
          trend:
            - average: 0.0,
              sampled_at: '2024-09-08T00:00:00+00:00'
            - average: 0.0,
              sampled_at: '2024-09-11T00:00:00+00:00'
            - average: 0.0,
              sampled_at: '2024-09-13T00:00:00+00:00'
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_rebuffer_count_drilldown:
      type: object
      description: ''
      properties:
        media:
          type: object
          title: Array of media
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the live stream
                or video.
              example: ''
            rebuffer_count:
              type: number
              description: The average rebuffer count of the specific live stream or video.
              example: ''
              format: float
            plays:
              type: integer
              description: >-
                The total number of plays for a live stream or video. A play is
                registered when the stream begins to play.
              example: ''
              format: int32
            playback_type:
              type: string
              description: The playback type of the stream.
              example: ''
            devices:
              type: object
              title: Array of devices
              description: 'An array of devices.        '
              properties:
                device:
                  type: string
                  description: The device type like **Desktop**.
                plays:
                  type: integer
                  description: The number of plays for the specific device type.
                  example: ''
                  format: int32
                rebuffer_count:
                  type: number
                  description: >-
                    Represents the average rebuffer count of the specific device
                    type.
                  example: ''
                  format: float
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
                page:
                  type: integer
                  description: >-
                    Returns a paginated view of results. A positive integer
                    indicates which page of the results are displayed. The
                    default is **0**.


                    - If page=0, rows 1-10 are returned.

                    - If page=1, rows 11-20 are returned.
                  example: ''
                  format: int32
                limit:
                  type: integer
                  description: >-
                    The number of results returned per page. The maximum number
                    of results per page is 20. The default is **10**.
                  example: ''
                  format: int32
                max_page:
                  type: integer
                  description: The maximum number of pages that will be returned.
                  example: ''
                  format: int32
                sort_by:
                  type: string
                  description: >-
                    Specifies by what order the objects are returned. The
                    default is **plays**.


                       enum: `metric` `plays`
                  example: ''
                sort_by_order:
                  type: string
                  description: >-
                    Specifies the order the objects are returned. The default is
                    **desc**.


                       enum: `asc` `desc`
                  example: ''
      example:
        media:
          - id: crtspppp
            rebuffer_count: 1.19
            plays: 233
            playback_type: vod
            devices:
              - device: Desktop
                plays: 174
                rebuffer_count: 1.19
              - device: Tablet
                plays: 59
                rebuffer_count: 1.19
        limits:
          from: '2024-09-08T14:35:00Z'
          to: '2024-10-08T14:35:00Z'
          page: 0
          limit: 10
          max_page: 7
          sort_by: metric
          sort_by_order: desc
    analytics_qoe_rebuffer_count_drilldown_trend:
      type: object
      description: ''
      properties:
        media:
          type: object
          title: Array of media
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the live stream
                or video.
              example: ''
            trend:
              type: object
              title: Array of rebuffer count drill down trends
              description: >-
                An array of rebuffer count drill down trends. The granularity of
                sampled data changes based on the from and to query values you
                use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                rebuffer_count:
                  type: number
                  description: The rebuffer count encountered during video playback.
                  example: ''
                  format: float
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        media:
          - id: 62588c40-9326-4a98-8836-a347bdad6e5b
            trend:
              - sampled_at: '2024-10-08T14:35:00Z'
                rebuffer_count: 1.19
              - sampled_at: '2024-10-08T14:35:00Z'
                rebuffer_count: 1.19
        limits:
          from: '2024-09-08T14:35:00Z'
          to: '2024-10-08T14:35:00Z'
    analytics_qoe_rebuffer_time_account:
      type: object
      description: ''
      properties:
        account:
          type: object
          title: account
          description: ''
          properties:
            rebuffer_time:
              type: integer
              description: >-
                The average time, in seconds, that the video pauses to rebuffer
                during one hour of playback.
              example: ''
              format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
            trend:
              type: object
              title: Array of rebuffer time trends
              description: >-
                An array of rebuffer time trend data. The granularity of sampled
                data changes based on the from and to query values you use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                average:
                  type: number
                  description: >-
                    The average time, in seconds, that the video pauses to
                    rebuffer during one hour of playback.
                  example: ''
                  format: float
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        account:
          rebuffer_time: 165.99156363636365
          time_zone: Etc/UTC
          trend:
            - average: 0.0,
              sampled_at: '2024-09-08T00:00:00+00:00'
            - average: 1.19,
              sampled_at: '2024-09-11T00:00:00+00:00'
            - average: 1.19,
              sampled_at: '2024-09-13T00:00:00+00:00'
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_rebuffer_time_media_id:
      type: object
      description: ''
      properties:
        media:
          type: object
          title: media
          description: ''
          properties:
            rebuffer_time:
              type: integer
              description: >-
                The average time, in seconds, that the video pauses to rebuffer
                during one hour of playback.
              example: ''
              format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
            trend:
              type: object
              title: Array of rebuffer time trends
              description: >-
                An array of rebuffer time trend data. The granularity of sampled
                data changes based on the from and to query values you use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                average:
                  type: integer
                  description: >-
                    The average time, in seconds, that the video pauses to
                    rebuffer during one hour of playback.
                  example: ''
                  format: int32
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        media:
          rebuffer_time: 1.71232543562145
          time_zone: America/New_York
          trend:
            - average: 1.0,
              sampled_at: '2024-09-08T00:00:00+00:00'
            - average: 1.9829059829059829,
              sampled_at: '2024-09-11T00:00:00+00:00'
            - average: 1.806060606060606,
              sampled_at: '2024-09-13T00:00:00+00:00'
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_rebuffer_time_drilldown:
      type: object
      description: ''
      properties:
        media:
          type: object
          title: Array of media
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the live stream
                or video.
              example: ''
            rebuffer_time:
              type: number
              description: The average rebuffer time of the specific live stream or video.
              example: ''
              format: float
            plays:
              type: integer
              description: >-
                The total number of plays for a live stream or video. A play is
                registered when the stream begins to play.
              example: ''
              format: int32
            playback_type:
              type: string
              description: The playback type of the stream.
              example: ''
            devices:
              type: object
              title: Array of devices
              description: 'An array of devices.        '
              properties:
                device:
                  type: string
                  description: The device type like **Desktop**.
                plays:
                  type: integer
                  description: The number of plays for the specific device type.
                  example: ''
                  format: int32
                rebuffer_time:
                  type: number
                  description: >-
                    Represents the average rebuffer time of the specific device
                    type.
                  example: ''
                  format: float
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
                page:
                  type: integer
                  description: >-
                    Returns a paginated view of results. A positive integer
                    indicates which page of the results are displayed. The
                    default is **0**.


                    - If page=0, rows 1-10 are returned.

                    - If page=1, rows 11-20 are returned.
                  example: ''
                  format: int32
                limit:
                  type: integer
                  description: >-
                    The number of results returned per page. The maximum number
                    of results per page is 20. The default is **10**.
                  example: ''
                  format: int32
                max_page:
                  type: integer
                  description: The maximum number of pages that will be returned.
                  example: ''
                  format: int32
                sort_by:
                  type: string
                  description: >-
                    Specifies by what order the objects are returned. The
                    default is **plays**.


                       enum: `metric` `plays`
                  example: ''
                sort_by_order:
                  type: string
                  description: >-
                    Specifies the order the objects are returned. The default is
                    **desc**.


                       enum: `asc` `desc`
                  example: ''
      example:
        media:
          - id: crtspppp
            rebuffer_time: 1.19
            plays: 233
            playback_type: vod
            devices:
              - device: Desktop
                plays: 174
                rebuffer_time: 1.19
              - device: Tablet
                plays: 59
                rebuffer_time: 1.19
        limits:
          from: '2024-09-08T14:35:00Z'
          to: '2024-10-08T14:35:00Z'
          page: 0
          limit: 10
          max_page: 7
          sort_by: metric
          sort_by_order: desc
    analytics_qoe_rebuffer_time_drilldown_trend:
      type: object
      description: ''
      properties:
        media:
          type: object
          title: Array of media
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the live stream
                or video.
              example: ''
            trend:
              type: object
              title: Array of rebuffer time drill down trends
              description: >-
                An array of rebuffer time drill down trends. The granularity of
                sampled data changes based on the from and to query values you
                use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>


                        
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                rebuffer_time:
                  type: number
                  description: The rebuffer time encountered during video playback.
                  example: ''
                  format: float
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        media:
          - id: 62588c40-9326-4a98-8836-a347bdad6e5b
            trend:
              - sampled_at: '2024-10-08T14:35:00Z'
                rebuffer_time: 1.19
              - sampled_at: '2024-10-08T14:35:00Z'
                rebuffer_time: 1.19
        limits:
          from: '2024-09-08T14:35:00Z'
          to: '2024-10-08T14:35:00Z'
    analytics_qoe_video_start_time_account:
      type: object
      description: ''
      properties:
        account:
          type: object
          title: account
          description: ''
          properties:
            average:
              type: integer
              description: >-
                The average time, in seconds, from when a user requests a video
                stream until playback begins.
              example: ''
              format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
            quantile_25:
              type: integer
              description: >-
                The video start time of 25th percentile of video streams. This
                means that 25% of the users have a video start time equal to or
                less than this value.
              example: ''
              format: int32
            quantile_50:
              type: integer
              description: >-
                The video start time of 50th percentile of video streams. This
                means that 50% of the users have a video start time equal to or
                less than this value.
              example: ''
              format: int32
            quantile_75:
              type: integer
              description: >-
                The video start time of 75th percentile of video streams. This
                means that 75% of the users have a video start time equal to or
                less than this value.
              example: ''
              format: int32
            quantile_95:
              type: integer
              description: >-
                The video start time of 95th percentile of video streams. This
                means that 95% of the users have a video start time equal to or
                less than this value.
              example: ''
              format: int32
            quantile_99:
              type: integer
              description: >-
                The video start time of 99th percentile of video streams. This
                means that 99% of the users have a video start time equal to or
                less than this value.
              example: ''
              format: int32
            trend:
              type: object
              title: Array of video start time trends
              description: >-
                An array of video start time trend data. The granularity of
                sampled data changes based on the from and to query values you
                use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                average:
                  type: integer
                  description: >-
                    The average time, in seconds, from when a user requests a
                    video stream until playback begins.
                  example: ''
                  format: int32
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        account:
          average: 400.64516129032256
          time_zone: Etc/UTC
          quantile_25: 300
          quantile_50: 300
          quantile_75: 300
          quantile_95: 1206
          quantile_99: 3390
          trend:
            - average: 0.0,
              sampled_at: '2024-09-08T00:00:00+00:00'
            - average: 525.0,
              sampled_at: '2024-09-11T00:00:00+00:00'
            - average: 382.0,
              sampled_at: '2024-09-13T00:00:00+00:00'
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_video_start_time_media_id:
      type: object
      description: ''
      properties:
        account:
          type: object
          title: account
          description: ''
          properties:
            average:
              type: integer
              description: >-
                The average time, in seconds, from when a user requests a video
                stream until playback begins. 
              example: ''
              format: int32
            time_zone:
              title: time_zone
              type: string
              description: >-
                The time zone in which the data is returned. The default time
                zone in which the data is returned is **Etc/UTC**.
            quantile_25:
              type: integer
              description: >-
                The video start time of 25th percentile of video streams. This
                means that 25% of the users have a video start time equal to or
                less than this value.
              example: ''
              format: int32
            quantile_50:
              type: integer
              description: >-
                The video start time of 50th percentile of video streams. This
                means that 50% of the users have a video start time equal to or
                less than this value.
              example: ''
              format: int32
            quantile_75:
              type: integer
              description: >-
                The video start time of 75th percentile of video streams. This
                means that 75% of the users have a video start time equal to or
                less than this value.
              example: ''
              format: int32
            quantile_95:
              type: integer
              description: >-
                The video start time of 95th percentile of video streams. This
                means that 95% of the users have a video start time equal to or
                less than this value.
              example: ''
              format: int32
            quantile_99:
              type: integer
              description: >-
                The video start time of 99th percentile of video streams. This
                means that 99% of the users have a video start time equal to or
                less than this value.
              example: ''
              format: int32
            trend:
              type: object
              title: Array of video start time trends
              description: >-
                An array of video start time trend data. The granularity of
                sampled data changes based on the from and to query values you
                use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                average:
                  type: integer
                  description: >-
                    The average time, in seconds, from when a user requests a
                    video stream until playback begins.
                  example: ''
                  format: int32
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        media:
          average: 400.64516129032256
          time_zone: Etc/UTC
          quantile_25: 300
          quantile_50: 300
          quantile_75: 300
          quantile_95: 1206
          quantile_99: 3390
          trend:
            - average: 0.0,
              sampled_at: '2024-09-08T00:00:00+00:00'
            - average: 525.0,
              sampled_at: '2024-09-11T00:00:00+00:00'
            - average: 382.0,
              sampled_at: '2024-09-13T00:00:00+00:00'
        limits:
          from: '2024-09-08T14:35:00.000Z'
          to: '2024-10-08T14:35:00.000Z'
    analytics_qoe_video_start_time_drilldown:
      type: object
      description: ''
      properties:
        media:
          type: object
          title: Array of media
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the live stream,
                real-time stream, or video.
              example: ''
            video_start_time:
              type: number
              description: >-
                The average video start time of the specific live stream,
                real-time stream, or video.
              example: ''
              format: float
            plays:
              type: integer
              description: >-
                The total number of plays for a live stream, real-time stream,
                or video. A play is registered when the stream begins to play.
              example: ''
              format: int32
            playback_type:
              type: string
              description: The playback type of the stream.
              example: ''
            devices:
              type: object
              title: Array of devices
              description: 'An array of devices.        '
              properties:
                device:
                  type: string
                  description: The device type like **Desktop**.
                plays:
                  type: integer
                  description: The number of plays for the specific device type.
                  example: ''
                  format: int32
                video_start_time:
                  type: number
                  description: >-
                    Represents the average video start time of the specific
                    device type.
                  example: ''
                  format: float
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
                page:
                  type: integer
                  description: >-
                    Returns a paginated view of results. A positive integer
                    indicates which page of the results are displayed. The
                    default is **0**.


                    - If page=0, rows 1-10 are returned.

                    - If page=1, rows 11-20 are returned.
                  example: ''
                  format: int32
                limit:
                  type: integer
                  description: >-
                    The number of results returned per page. The maximum number
                    of results per page is 20. The default is **10**.
                  example: ''
                  format: int32
                max_page:
                  type: integer
                  description: The maximum number of pages that will be returned.
                  example: ''
                  format: int32
                sort_by:
                  type: string
                  description: >-
                    Specifies by what order the objects are returned. The
                    default is **plays**.


                       enum: `metric` `plays`
                  example: ''
                sort_by_order:
                  type: string
                  description: >-
                    Specifies the order the objects are returned. The default is
                    **desc**.


                       enum: `asc` `desc`
                  example: ''
      example:
        media:
          - id: crtspppp
            video_start_time: 1.19
            plays: 233
            playback_type: vod
            devices:
              - device: Desktop
                plays: 174
                video_start_time: 1.19
              - device: Tablet
                plays: 59
                video_start_time: 1.19
        limits:
          from: '2024-09-08T14:35:00Z'
          to: '2024-10-08T14:35:00Z'
          page: 0
          limit: 10
          max_page: 7
          sort_by: metric
          sort_by_order: desc
    analytics_qoe_video_start_time_drilldown_trend:
      type: object
      description: ''
      properties:
        media:
          type: object
          title: Array of media
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the live stream,
                real-time stream, or video.
              example: ''
            trend:
              type: object
              title: Array of video start time drill down trends
              description: >-
                An array of video start time drill down trends. The granularity
                of sampled data changes based on the from and to query values
                you use:


                <ul><li>0 minutes to 8 hours - Samples returned per minute</li>
                <li>8 hours, 1 second to 24 hours - Samples returned per
                hour</li> <li>24 hours, 1 second to 175 days - Samples returned
                per day</li> <li>175 days to 14 years - Samples returned per
                month</li> <li>14 years or greater - Samples returned per
                year</li></ul>
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                video_start_time:
                  type: number
                  description: The video start time encountered during video playback.
                  example: ''
                  format: float
            limits:
              type: object
              description: The time frame represented in the response.
              properties:
                from:
                  type: string
                  description: The start of the range of time represented in the response.
                  example: ''
                  format: date-time
                to:
                  type: string
                  description: The end of the range of time represented in the response.
                  example: ''
                  format: date-time
      example:
        media:
          - id: 62588c40-9326-4a98-8836-a347bdad6e5b
            trend:
              - sampled_at: '2024-10-08T14:35:00Z'
                video_start_time: 1.19
              - sampled_at: '2024-10-08T14:35:00Z'
                video_start_time: 1.19
        limits:
          from: '2024-09-08T14:35:00Z'
          to: '2024-10-08T14:35:00Z'
    usage_transcoders:
      type: object
      title: transcoders
      description: ''
      properties:
        transcoders:
          type: object
          description: ''
          properties:
            id:
              type: integer
              description: The unique alphanumeric string that identifies the transcoder.
              example: ''
              format: int32
            name:
              type: string
              description: A descriptive name for the transcoder.
              example: ''
            archived:
              type: boolean
              description: >-
                A value of **true** indicates that the transcoder has been
                removed from Wowza Video.
              example: ''
            billing_mode:
              type: string
              description: >-
                The billing mode for the transcoder. The default is
                **pay_as_you_go**.


                **pay_as_you_go** — Billed as a single event. A single event is
                use-based and you incur charges for the time spent streaming.


                **twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel
                is unlimited stream time for one channel. This billing mode
                doesn't incur overages, since it's unlimited.
              example: ''
              enum:
                - pay_as_you_go
                - twentyfour_seven
            transcoder_type:
              type: string
              description: The type of transcoder. The default is **transcoded**.
              example: ''
              enum:
                - transcoded
                - passthrough
            egress_bytes:
              type: integer
              description: >-
                The amount of content, in bytes, that went through the
                transcoder during the selected time frame.
              example: ''
              format: int32
            egress_seconds:
              type: integer
              description: >-
                The amount of time, in seconds, that it took for the stream to
                be processed.
              example: ''
            egress_seconds_additional_targets:
              type: integer
              description: >-
                The length of time, in seconds, that additional stream targets
                pulled from storage during the selected time frame.
                Subscriptions prices include egress for one target; additional
                targets incur additional charges.
              example: ''
              format: int32
        pagination:
          type: object
          description: Page information for the results generated by the query.
          properties:
            payload_version:
              type: integer
              description: The pagination object version.
            total_records:
              type: integer
              description: >-
                The total number of records in the database that match the
                query.
              example: ''
            page:
              type: integer
              description: The page being displayed.
              example: ''
            per_page:
              type: integer
              description: The number of records included on each page of results.
              example: ''
            total_pages:
              type: integer
              description: The total number of pages generated by the query.
              example: ''
            page_first_index:
              type: integer
              description: The 0-based index of the first record on the page returned.
              example: ''
            page_last_index:
              type: integer
              description: The 0-based index of the last record on the page returned.
              example: ''
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        transcoders:
          - id: bbrjj3ml
            name: transcoder name
            archived: false
            transcoder_type: transcoded
            billing_mode: pay_as_you_go
            egress_bytes: 0
            egress_seconds: 44
            egress_seconds_additional_targets: 23
          - id: mertj8nd
            name: my other transcoder
            archived: false
            transcoder_type: transcoded
            billing_mode: pay_as_you_go
            egress_bytes: 80384481
            egress_seconds: 158
            egress_seconds_additional_targets: 0
        pagination:
          payload_version: '1.0'
          total_records: 2130
          page: 3
          per_page: 3
          total_pages: 710
          page_first_index: 6
          page_last_index: 8
        limits:
          from: '2019-10-01T07:00:00.000Z'
          to: '2019-10-16T11:00:00.000Z'
    usage_transcoder:
      type: object
      title: transcoders
      description: ''
      properties:
        transcoders:
          type: object
          description: ''
          properties:
            id:
              type: integer
              description: The unique alphanumeric string that identifies the transcoder.
              example: ''
              format: int32
            name:
              type: string
              description: A descriptive name for the transcoder.
              example: ''
            archived:
              type: boolean
              description: >-
                A value of **true** indicates that the transcoder has been
                removed from Wowza Video.
              example: ''
            billing_mode:
              type: string
              description: >-
                The billing mode for the transcoder. The default is
                **pay_as_you_go**.


                **pay_as_you_go** — Billed as a single event. A single event is
                use-based and you incur charges for the time spent streaming.


                **twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel
                is unlimited stream time for one channel. This billing mode
                doesn't incur overages, since it's unlimited.
              example: ''
              enum:
                - pay_as_you_go
                - twentyfour_seven
            transcoder_type:
              type: string
              description: The type of transcoder. The default is **transcoded**.
              example: ''
              enum:
                - transcoded
                - passthrough
            egress_bytes:
              type: integer
              description: >-
                The amount of content, in bytes, that went through the
                transcoder during the selected time frame.
              example: ''
              format: int32
            egress_seconds:
              type: integer
              description: >-
                The amount of time, in seconds, that it took for the stream to
                be processed.
              example: ''
            egress_seconds_additional_targets:
              type: integer
              description: >-
                The length of time, in seconds, that additional stream targets
                pulled from storage during the selected time frame.
                Subscriptions prices include egress for one target; additional
                targets incur additional charges.
              example: ''
              format: int32
            viewing_seconds:
              type: integer
              description: >-
                The total length of time, in seconds, that the stream was played
                at the target. May be longer than the duration of the stream.
              example: ''
              format: int32
            viewing_bytes:
              type: integer
              description: >-
                The amount of content, in bytes, that went through the
                transcoder during the selected time frame.
              example: ''
              format: int32
            trend:
              type: object
              title: Array of viewer trends
              description: >-
                An array of viewer trend data. The granularity of sampled data
                changes based on the from and to query values you use:


                Requests made for data within the past 30 days, return the
                following sample intervals: <ul><li>0 minutes to 3 hours -
                Samples returned per minute</li> <li>3 hours, 1 second to 24
                hours - Samples returned per hour</li> <li>24 hours, 1 second to
                90 days - Samples returned per day</li></ul>


                <strong>Defaults</strong>: from = last billing date, to = end of
                current day
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                viewing_seconds:
                  type: integer
                  description: >-
                    The total length of time, in seconds, that the stream was
                    played at the target. May be longer than the duration of the
                    stream.
                  example: ''
                  format: int32
                viewing_bytes:
                  type: integer
                  description: >-
                    The amount of content, in bytes, that went through the
                    transcoder during the selected time frame.
                  example: ''
                  format: int32
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        transcoder:
          id: bbrjj3ml
          name: transcoder name
          archived: false
          transcoder_type: transcoded
          billing_mode: pay_as_you_go
          egress_bytes: 0
          egress_seconds: 44
          egress_seconds_additional_targets: 23
          viewing_seconds: 90
          viewing_bytes: 49
          trend:
            - sampled_at: '2019-10-01T08:00:00.000Z'
              viewing_seconds: 45
              viewing_bytes: 20
        limits:
          from: '2019-10-01T07:00:00.000Z'
          to: '2019-10-16T11:00:00.000Z'
    usage_transcoder_summary:
      type: object
      title: transcoders
      description: ''
      properties:
        summary:
          type: object
          description: ''
          properties:
            egress_bytes:
              type: integer
              description: >-
                The total amount of content, in bytes, that went through all
                transcoders during the selected time frame.
              example: ''
              format: int32
            egress_seconds:
              type: integer
              description: >-
                The total amount of time, in seconds, that it took for all
                transcoders to be processed.
              example: ''
            configurations:
              type: object
              description: ''
              properties:
                transcoder_type:
                  type: string
                  description: The type of transcoder. The default is **transcoded**.
                  example: ''
                  enum:
                    - transcoded
                    - passthrough
                billing_mode:
                  type: string
                  description: >-
                    The billing mode for the transcoder. The default is
                    **pay_as_you_go**.


                    **pay_as_you_go** — Billed as a single event. A single event
                    is use-based and you incur charges for the time spent
                    streaming.


                    **twentyfour_seven** — Billed as a 24x7 channel. A 24x7
                    channel is unlimited stream time for one channel. This
                    billing mode doesn't incur overages, since it's unlimited.
                  example: ''
                  enum:
                    - pay_as_you_go
                    - twentyfour_seven
                egress_bytes:
                  type: integer
                  description: >-
                    The amount of content, in bytes, that went through the
                    transcoder during the selected time frame.
                  example: ''
                  format: int32
                egress_seconds:
                  type: integer
                  description: >-
                    The amount of time, in seconds, that it took for the
                    transcoder to be processed.
                  example: ''
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        summary:
          egress_bytes: 3000
          egress_seconds: 300
          configurations:
            - transcoder_type: transcoded
              billing_mode: pay_as_you_go
              egress_bytes: 1000
              egress_seconds: 200
            - transcoder_type: passthrough
              billing_mode: twentyfour_seven
              egress_bytes: 2000
              egress_seconds: 100
        limits:
          from: '2019-02-15T00:00:00.000Z'
          to: '2019-09-24T00:00:00.000Z'
    usage_stream_targets:
      type: object
      description: ''
      properties:
        stream_targets:
          type: object
          title: Array of stream targets
          description: An array of stream targets and the details of their CDN usage.
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the stream
                target.
              format: int32
            name:
              type: string
              description: >-
                A descriptive name for the stream target. Maximum 255
                characters.
              example: ''
            archived:
              type: boolean
              description: >-
                A value of **true** indicates that the stream target has been
                removed from Wowza Video.
            type:
              type: string
              description: >-
                The type of stream target. <br/> **fastly** is a Wowza CDN on
                Fastly target.
              example: ''
              enum:
                - fastly
            viewing_seconds:
              type: integer
              description: >-
                The total length of time, in seconds, that the stream was played
                at the target. May be longer than the duration of the stream.
              example: ''
              format: int32
            viewing_bytes:
              type: integer
              description: >-
                The amount of content, in bytes, that went through the stream
                target during the selected time frame.
              example: ''
              format: int32
        pagination:
          type: object
          description: Page information for the results generated by the query.
          properties:
            payload_version:
              type: integer
              description: The pagination object version.
            total_records:
              type: integer
              description: >-
                The total number of records in the database that match the
                query.
              example: ''
            next_page_key:
              type: string
              description: The key ID of the next page of results.
              example: ''
            per_page:
              type: integer
              description: The number of records included on each page of results.
              example: ''
            total_pages:
              type: integer
              description: The total number of pages generated by the query.
              example: ''
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        stream_targets:
          - id: tvctq36g
            name: My Stream Target
            archived: true
            type: fastly
            viewing_seconds: 44925498
            viewing_bytes: 22886
          - id: bac1256
            name: My Other Stream Target
            archived: false
            type: fastly
            viewing_seconds: 593275043
            viewing_bytes: 22886
        pagination:
          payload_version: '2.0'
          total_records: 269
          next_page_key: 2jj8syfl
          per_page: 10
          total_pages: 27
        limits:
          from: '2019-11-07T00:00:00.000Z'
          to: '2019-12-05T00:00:00.000Z'
    usage_stream_target:
      type: object
      description: ''
      properties:
        stream_target:
          type: object
          title: stream_target
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the stream
                target.
              format: int32
            name:
              type: string
              description: >-
                A descriptive name for the stream target. Maximum 255
                characters.
              example: ''
            archived:
              type: boolean
              description: >-
                A value of **true** indicates that the stream target has been
                removed from Wowza Video.
            type:
              type: string
              description: >-
                The type of stream target. <br/> **fastly** is a Wowza CDN on
                Fastly target.
              example: ''
              enum:
                - fastly
            viewing_seconds:
              type: integer
              description: >-
                The total length of time, in seconds, that the stream was played
                at the target. May be longer than the duration of the stream.
              example: ''
              format: int32
            viewing_bytes:
              type: integer
              description: >-
                The amount of content, in bytes, that went through the stream
                target during the selected time frame.
              example: ''
              format: int32
            trend:
              type: object
              title: Array of viewer trends
              description: >-
                An array of viewer trend data. The granularity of sampled data
                changes based on the from and to query values you use:


                Requests made for data within the past 30 days, return the
                following sample intervals: <ul><li>0 minutes to 3 hours -
                Samples returned per minute</li> <li>3 hours, 1 second to 24
                hours - Samples returned per hour</li> <li>24 hours, 1 second to
                90 days - Samples returned per day</li></ul>


                <strong>Defaults</strong>: from = last billing date, to = end of
                current day
              properties:
                sampled_at:
                  type: string
                  description: The date and time the trend data was sampled.
                  format: date-time
                viewing_seconds:
                  type: integer
                  description: >-
                    The total length of time, in seconds, that the stream was
                    played at the target. May be longer than the duration of the
                    stream.
                  example: ''
                  format: int32
                viewing_bytes:
                  type: integer
                  description: >-
                    The amount of content, in bytes, that went through the
                    transcoder during the selected time frame.
                  example: ''
                  format: int32
            zones:
              type: object
              title: Hash of zones
              description: >-
                A hash of zones with CDN usage, keyed by the name of the billing
                zone where the usage was generated.
              properties:
                name:
                  type: string
                  description: The name of the billing zone where the usage was generated.
                  example: ''
                viewing_bytes:
                  type: integer
                  description: >-
                    The amount of content, in bytes, that went through the
                    stream target during the selected time frame.
                  example: ''
                  format: int32
                type:
                  type: string
                  description: >-
                    The type of stream target. <br/> **fastly** is a Wowza CDN
                    on Fastly target.
                  example: ''
                  enum:
                    - fastly
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        stream_target:
          id: tvctq36g
          name: My Stream Target
          archived: true
          type: fastly
          viewing_seconds: 44925498
          viewing_bytes: 22886
          trend:
            - sampled_at: '2019-10-01T08:00:00.000Z'
              viewing_seconds: 45
              viewing_bytes: 20
          zones:
            - name: global
              type: fastly
              viewing_bytes: 22886
        limits:
          from: '2019-11-07T00:00:00.000Z'
          to: '2019-12-05T00:00:00.000Z'
    usage_stream_target_summary:
      type: object
      description: ''
      properties:
        summary:
          type: object
          title: summary
          description: ''
          properties:
            viewing_seconds:
              type: integer
              description: >-
                The total length of time, in seconds, that the stream was played
                at the target. May be longer than the duration of the stream.
              example: ''
              format: int32
            viewing_bytes:
              type: integer
              description: >-
                The amount of content, in bytes, that went through the stream
                target during the selected time frame.
              example: ''
              format: int32
            zones:
              type: object
              title: Hash of zones
              description: >-
                A hash of zones with CDN usage, keyed by the name of the billing
                zone where the usage was generated.
              properties:
                name:
                  type: string
                  description: The name of the billing zone where the usage was generated.
                  example: ''
                viewing_bytes:
                  type: integer
                  description: >-
                    The amount of content, in bytes, that went through the
                    stream target during the selected time frame.
                  example: ''
                  format: int32
                type:
                  type: string
                  description: >-
                    The type of stream target. <br/> **fastly** is a Wowza CDN
                    on Fastly target.
                  example: ''
                  enum:
                    - fastly
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        summary:
          viewing_seconds: 67925498
          viewing_bytes: 22886
          zones:
            - name: global
              type: fastly
              viewing_bytes: 12886
        limits:
          from: '2019-11-07T00:00:00.000Z'
          to: '2019-12-05T00:00:00.000Z'
    usage_real_time_streams:
      type: object
      description: ''
      properties:
        real_time_streams:
          type: object
          title: Array of real-time streams
          description: An array of real-time streams and the details of their CDN usage.
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the real-time
                stream.
              format: int32
            name:
              type: string
              description: >-
                A descriptive name for the real-time stream. Maximum 255
                characters.
              example: ''
            bytes_in:
              type: integer
              description: >-
                The amount of content, in bytes, that came from a video source
                in to Wowza Video during the selected time frame.
              format: int32
            bytes_out:
              type: integer
              description: >-
                The amount of content, in bytes, that went to a viewer during
                the selected time frame.
              format: int32
              example: ''
        pagination:
          type: object
          description: Page information for the results generated by the query.
          properties:
            payload_version:
              type: integer
              description: The pagination object version.
            total_records:
              type: integer
              description: >-
                The total number of records in the database that match the
                query.
              example: ''
            next_page_key:
              type: string
              description: The key ID of the next page of results.
              example: ''
            per_page:
              type: integer
              description: The number of records included on each page of results.
              example: ''
            total_pages:
              type: integer
              description: The total number of pages generated by the query.
              example: ''
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        real_time_streams:
          - id: tvctq36g
            name: My Real Time Stream
            bytes_in: 0
            bytes_out: 222
          - id: bac1256
            name: My Other Real Time Stream
            bytes_in: 888
            bytes_out: 1111
        pagination:
          payload_version: '2.0'
          total_records: 269
          next_page_key: 2jj8syfl
          per_page: 10
          total_pages: 27
        limits:
          from: '2019-11-07T00:00:00.000Z'
          to: '2019-12-05T00:00:00.000Z'
    usage_real_time_stream:
      type: object
      description: ''
      properties:
        real_time_stream:
          type: object
          title: real_time_stream
          description: ''
          properties:
            id:
              type: string
              description: >-
                The unique alphanumeric string that identifies the real-time
                stream.
              format: int32
            name:
              type: string
              description: >-
                A descriptive name for the real-time stream. Maximum 255
                characters.
              example: ''
            bytes_in:
              type: integer
              description: >-
                The amount of content, in bytes, that came from a video source
                in to Wowza Video during the selected time frame.
              format: int32
            bytes_out:
              type: integer
              description: >-
                The amount of content, in bytes, that went to a viewer during
                the selected time frame.
              format: int32
              example: ''
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        real_time_stream:
          id: tvctq36g
          name: My Real Time Stream
          bytes_in: 222
          bytes_out: 0
        limits:
          from: '2019-11-07T00:00:00.000Z'
          to: '2019-12-05T00:00:00.000Z'
    usage_real_time_stream_summary:
      type: object
      description: ''
      properties:
        summary:
          type: object
          title: summary
          description: ''
          properties:
            bytes_in:
              type: integer
              description: >-
                The amount of content, in bytes, that came from a video source
                in to Wowza Video during the selected time frame.
              example: ''
              format: int32
            bytes_out:
              type: integer
              description: >-
                The amount of content, in bytes, that went to a viewer during
                the selected time frame.
              example: ''
              format: int32
        limits:
          type: object
          description: The time frame represented in the response.
          properties:
            from:
              type: string
              description: The start of the range of time represented in the response.
              example: ''
              format: date-time
            to:
              type: string
              description: The end of the range of time represented in the response.
              example: ''
              format: date-time
      example:
        summary:
          bytes_in: 987467984710
          bytes_out: 1583413248468
        limits:
          from: '2023-05-07T00:00:00.000Z'
          to: '2023-05-26T00:00:00.000Z'
    index_real_time_stream:
      type: object
      title: real_time_streams
      description: ''
      properties:
        created_at:
          type: string
          description: The date and time that the real-time stream was created.
          example: ''
          format: date-time
        id:
          type: string
          description: The unique alphanumeric string that identifies the real-time stream.
          example: ''
        name:
          type: string
          description: A descriptive name for the real-time stream.
          example: ''
        state:
          type: string
          description: The state of the stream.
          example: ''
          enum:
            - active
            - archived
            - disabled
            - stopped
        updated_at:
          type: string
          description: The date and time that the real-time stream was updated.
          example: ''
          format: date-time
    real_time_streams:
      type: object
      description: ''
      required:
        - real_time_streams
      properties:
        real_time_streams:
          type: array
          items:
            $ref: '#/components/schemas/index_real_time_stream'
      example:
        real_time_streams:
          - id: 2adffc17
            name: MyRealTimeStream
            state: started
            created_at: '2021-01-29T17:16:21.849Z'
            updated_at: '2021-01-31T16:06:47.849Z'
          - id: if7le8ip
            name: MyRealTimeStream2
            state: started
            created_at: '2020-01-29T17:16:21.849Z'
            updated_at: '2020-01-31T02:26:05.849Z'
          - id: dd4udt1b
            name: MyRealTimeStream3
            state: started
            created_at: '2020-01-29T17:16:21.849Z'
            updated_at: '2020-01-30T18:13:18.849Z'
    real_time_stream_create:
      type: object
      description: ''
      properties:
        real_time_stream:
          type: object
          title: real_time_stream
          description: ''
          required:
            - name
          properties:
            name:
              type: string
              description: >-
                A descriptive name for the real-time stream. Maximum 255
                characters.


                <blockquote><strong>Note:</strong>  If you record a real-time
                stream, the name is used to for the recording file name. To
                avoid file management issues in storage, Wowza Video removes or
                replaces special  characters in file names, so the recording
                file name might vary from the name you provided
                here.</blockquote>
              example: ''
            description:
              type: string
              description: An optional description of the real-time stream.
              example: ''
            disable_vod_encoder:
              type: boolean
              description: >-
                Skips VOD encoding and only creates an MP4 file for download. No
                VOD stream is created from the real-time stream. 


                Can only be set when **recording** is true and you can't change
                this value after you create the stream.


                **Default:** false


                **Example:** <code>"disable_vod_encoder": true</code>
            enable_secure_viewer:
              type: boolean
              description: |-
                Require viewers to pass a security token for playback.

                **Example:** <code>"enable_secure_viewer": false</code>
            expires_on:
              type: string
              description: >-
                The date and time the security token expires. Specify
                **YYYY-MM-DD HH:MM:SS**, where **HH** is a 24-hour clock in UTC.
                If you don't specify **HH:MM:SS**, the token expires at 12AM UTC
                on the specified day.


                Required when *enable_secure_viewer* is **true**.


                **Example:** <code>"expires_on": "2021-10-27 23:08:55
                UTC"</code>
              format: date-time
            region:
              type: string
              description: >-
                An option to set the regional server the stream is distributed
                through. Select the region closest to your broadcast location
                for the most reliable stream. If you select the auto option,
                Wowza Video selects the region based on the publisher's
                location.


                **Default:** phoenix


                **Example:** <code>"region": amsterdam</code>
              example: ''
              enum:
                - phoenix
                - amsterdam
                - singapore
                - bangalore
                - auto
            recording:
              type: boolean
              description: >-
                If **true**, records the real-time stream so you can download an
                MP4 later. The recording starts when the stream starts and stops
                automatically when the stream stops.


                Recordings for real-time streams capture up to twelve hours of
                content in a single MP4 file. If the real-time stream recording
                is longer twelve hours, you'll have multiple files for the
                recording. 


                **Default:** false


                <blockquote>Note: You can't update this value after you create
                the stream.</blockquote>


                **Example:** <code>"recording": true</code>
            reference_id:
              type: string
              description: >-
                A unique, alphanumeric ID returned in real-time stream webhook
                payloads. Setting a *reference_id* is useful if you have an ID
                in your system or application you want to associate with
                real-time stream events that trigger webhooks. Maximum 70
                characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|


                You can't use brackets or quotation marks.


                See <a
                href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza
                Video Webhook Event Reference Documentation</a> to learn about
                webhooks.


                Available from version 1.12.


                **Example:** <code>"reference_id": "mySystemID_01"</code>
            enable_player_and_hosted_page:
              type: boolean
              description: >-
                If **true**, enables a player and hosted page for the real-time
                stream.


                **Default:** true


                <blockquote>Note: You can't update this value after you create
                the stream.</blockquote>


                **Example:** <code>"enable_player_and_hosted_page": true</code>
            player_id:
              type: string
              description: >-
                (Available from version 2.0) The unique alphanumeric string that
                identifies the player configuration to use for this stream. 
                    
                    
                When you pass a player configuration ID, Wowza Video uses that
                player configuration to customize and style the player. If you
                don't pass a value, the default player configuration for the
                account is used.


                Create and edit player configurations in the user interface. The
                ID is on the **General** tab for the player configuration.


                **Default**: Default player configuration


                **Example**: 2205b4e8-b160-43c2-868d-d88698a4e850  
            logo_image:
              type: string
              description: >-
                A Base64-encoded string representation of a GIF, JPEG, or PNG
                logo  file that appears partially transparent in a corner of the
                player throughout playback. Logo file must be 2.5 MB or smaller.


                **Example:** <code>"logo_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>   
              example: ''
            logo_position:
              type: string
              description: >-
                The corner of the player in which you want the player logo to
                appear. The default is **top-left**.


                **Example:** <code>"logo_position": "top-right"</code>
              example: ''
              enum:
                - top-left
                - top-right
                - bottom-left
                - bottom-right
            video_poster_image:
              type: string
              description: >-
                The path to a GIF, JPEG, or PNG poster image that appears in the
                player before the stream begins. Poster image files must be 2.5
                MB or smaller.


                **Example:** <code>"video_poster_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>
              example: ''
            width:
              type: integer
              description: >-
                The width, in pixels, of a fixed-size player. The default is
                **640**.


                **Example:** <code>"width": 640</code>
              example: ''
              format: int32
            hosted_page:
              type: object
              description: Configuration of the hosted page.
              properties:
                title:
                  type: string
                  description: >-
                    A title for the page that appears above the player. Can't
                    include custom HTML, JavaScript, or other tags.


                    **Example:** <code>"title": "My Hosted Page"</code>
                  example: ''
                description:
                  type: string
                  description: >-
                    A description that appears on the hosted page below the
                    player. Can't include custom HTML, JavaScript, or other
                    tags.


                    **Example:** <code>"description": "My Hosted Page
                    Description"</code>
                  example: ''
                logo_image_url:
                  type: string
                  description: >-
                    The path to a GIF, JPEG, or PNG logo file that appears in
                    the upper-left corner of the hosted page. Logo file must be
                    2.5 MB or smaller.
                  example: ''
                sharing_icons:
                  type: boolean
                  description: >-
                    Icons that let viewers share the stream on Facebook,
                    Google+, Twitter, and by email. The default, **true**,
                    includes sharing icons on the hosted page. Specify **false**
                    to omit sharing icons.


                    **Example:** <code>"sharing_icons": false</code>
                  example: ''
      example:
        real_time_stream:
          name: MyRealTimeStream
          description: This is my first real-time stream.
    real_time_stream:
      type: object
      description: ''
      properties:
        created_at:
          type: string
          description: The date and time that the real-time stream was created.
          example: ''
          format: date-time
        id:
          type: string
          description: >-
            The unique identifier of the real-time stream. Use this ID to
            perform other operations on the stream, like getting the details of
            the stream or deleting it.
          example: ''
        name:
          type: string
          description: A descriptive name for the real-time stream.
          example: ''
        stream_name:
          type: string
          description: The generated alphanumeric stream name you pass to the SDK.
          example: ''
        token:
          type: string
          description: The authentication token you pass to the SDK.
          example: ''
        subscribe_token:
          type: string
          description: >-
            A secure token that must be passed by viewers for playback.
            Generated after you set *enable_secure_viewer* to **true**.
        rtmp_url:
          type: string
          description: The URL you can use to configure an RTMP encoder as the source.
        enable_secure_viewer:
          type: boolean
          description: Require viewers to pass a security token for playback.
        expires_on:
          type: string
          description: >-
            The date and time the security token expires. Specify **YYYY-MM-DD
            HH:MM:SS**, where **HH** is a 24-hour clock in UTC. If you don't
            specify **HH:MM:SS**, the token expires at 12AM UTC on the specified
            day. Required when *enable_secure_viewer* is **true**.
          format: date-time
        state:
          type: string
          description: The state of the stream.
          example: ''
          enum:
            - started
            - stopped
            - disabled
        region:
          type: string
          description: >-
            An option to set the regional server the stream is distributed
            through. Select the region closest to your broadcast location for
            the most reliable stream. If you select the auto option, Wowza Video
            selects the region based on the publisher's location.


            **Default:** phoenix


            **Example:** <code>"region": amsterdam</code>
          example: ''
          enum:
            - phoenix
            - amsterdam
            - singapore
            - bangalore
            - auto
        recording:
          type: boolean
          description: >-
            If **true**, records the real-time stream so you can download an MP4
            later. The recording starts when the stream starts and stops
            automatically when the stream stops. 


            Recordings for real-time streams capture up to twelve hours of
            content in a single MP4 file. If the real-time stream recording is
            longer twelve hours, you'll have multiple files for the recording.


            **Default:** false


            <blockquote>Note: You can't update this value after you create the
            stream.</blockquote>


            **Example:** <code>"recording": true</code>
        reference_id:
          type: string
          description: >-
            A unique, alphanumeric ID returned in real-time stream webhook
            payloads. Setting a *reference_id* is useful if you have an ID in
            your system or application you want to associate with real-time
            stream events that trigger webhooks. Maximum 70 characters. Can only
            contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|


            You can't use brackets or quotation marks.


            See <a
            href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza
            Video Webhook Event Reference Documentation</a> to learn about
            webhooks.


            Available from version 1.12.


            **Example:** <code>"reference_id": "mySystemID_01"</code>
        disable_vod_encoder:
          type: boolean
          description: >-
            Skips VOD encoding and only creates an MP4 file for download. No VOD
            stream is created from the real-time stream. 


            Can only be set when **recording** is true and you can't change this
            value after you create the stream.


            **Default:** false


            **Example:** <code>"disable_vod_encoder": true</code>
        description:
          type: string
          description: An optional description of the real-time stream.
          example: ''
        enable_player_and_hosted_page:
          type: boolean
          description: >-
            If **true**, enables a player and hosted page for the real-time
            stream.


            **Default:** true


            <blockquote>Note: You can't update this value after you create the
            stream.</blockquote>


            **Example:** <code>"enable_player_and_hosted_page": true</code>
        player_id:
          type: string
          description: >-
            (Available from version 2.0) The unique alphanumeric string that
            identifies the player configuration to use for this stream. 
                    
                    
            When you pass a player configuration ID, Wowza Video uses that
            player configuration to customize and style the player. If you don't
            pass a value, the default player configuration for the account is
            used.


            Create and edit player configurations in the user interface. The ID
            is on the **General** tab for the player configuration.


            **Default**: Default player configuration


            <blockquote><strong>Note</strong>: <strong>player_id</strong> is not
            returned in the response if it's not explicitly sent and the default
            player configuration is used instead.</blockquote>


            **Example**: 2205b4e8-b160-43c2-868d-d88698a4e850  
        player_type:
          type: string
          description: >-
            (Available from version 2.0) The type of player associated with the
            stream. Streams created in legacy Wowza Video have a  player type of
            *wowza_flowplayer_v1*. Streams created in later versions of Wowza
            Video have a player type of *wowza_flowplayer_v2*.


            Knowing the player type is useful if you've migrated streams from
            legacy Wowza Video. The player for a stream created in the legacy
            version of Wowza Video isn't editable in the new platform. 


            **Example**: wowza_flowplayer_v1
          enum:
            - wowza_flowplayer_v1
            - wowza_flowplayer_v2
        flowplayer:
          type: boolean
          description: >-
            Indicates whether or not the player for the live stream is a Wowza
            Flowplayer player. **True** indicates the player is a Wowza
            Flowplayer player. Our new Wowza Video experience uses Wowza
            Flowplayer. If you are a Wowza Video legacy subscriber, Wowza
            Flowplayer is also the player used.


            **False** indicates the player is either an **original_html5**
            player or **wowza_player**. The original HTML and Wowza players are
            the players available for Wowza Streaming Cloud subscribers.
          example: ''
        embed_code:
          type: string
          description: >-
            The HTML code that can be used in an external webpage to host the
            Wowza Flowplayer.
          example: ''
        logo_image_url:
          type: string
          description: >-
            The path to a GIF, JPEG, or PNG logo file that appears partially
            transparent in a corner of the player throughout playback. Logo file
            must be 2.5 MB or smaller.  
          example: ''
        logo_position:
          type: string
          description: >-
            The corner of the player in which you want the player logo to
            appear. The default is **top-left**.


            **Example:** <code>"logo_position": "top-right"</code>
          example: ''
          enum:
            - top-left
            - top-right
            - bottom-left
            - bottom-right
        video_poster_image_url:
          type: string
          description: >-
            The path to a GIF, JPEG, or PNG poster image that appears in the
            player before the stream begins. Poster image files must be 2.5 MB
            or smaller.
          example: ''
        width:
          type: integer
          description: >-
            The width, in pixels, of a fixed-size player. The default is
            **640**.


            **Example:** <code>"width": 640</code>
          example: ''
          format: int32
        hosted_page:
          type: object
          description: Configuration of the hosted page.
          properties:
            url:
              type: string
              description: >-
                The URL of the Wowza Video-hosted webpage that viewers can visit
                to watch the stream.
              example: ''
            title:
              type: string
              description: >-
                A title for the page that appears above the player. Can't
                include custom HTML, JavaScript, or other tags.


                **Example:** <code>"title": "My Hosted Page"</code>
              example: ''
            description:
              type: string
              description: >-
                A description that appears on the hosted page below the player.
                Can't include custom HTML, JavaScript, or other tags.


                **Example:** <code>"description": "My Hosted Page
                Description"</code>
              example: ''
            logo_image_url:
              type: string
              description: >-
                The path to a GIF, JPEG, or PNG logo file that appears in the
                upper-left corner of the hosted page. Logo file must be 2.5 MB
                or smaller.
              example: ''
            sharing_icons:
              type: boolean
              description: >-
                Icons that let viewers share the stream on Facebook, Google+,
                Twitter, and by email. The default, **true**, includes sharing
                icons on the hosted page. Specify **false** to omit sharing
                icons.


                **Example:** <code>"sharing_icons": false</code>
              example: ''
        updated_at:
          type: string
          description: The date and time the real-time stream was updated.
          example: ''
          format: date-time
      example:
        id: 2adffc17
        name: MyRealTimeStream
        stream_name: 8d304b93f1684320a54f2798666eeca7
        token: 97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc
        rtmp_url: >-
          rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc
        enable_secure_viewer: false
        state: started
        region: amsterdam
        recording: true
        reference_id: mySystemID_01
        disable_vod_encoder: true
        description: This is my first real-time stream.
        enable_player_and_hosted_page: true
        player_id: 2205b4e8-b160-43c2-868d-d88698a4e850
        flowplayer: true
        embed_code: null
        logo_image_url: >-
          https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg
        logo_position: top-right
        video_poster_image_url: >-
          https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg
        width: 640
        hosted_page:
          title: MyRealTimeStreamHostedPage
          url: https://embed.flowplayer.com/hosted/default/e8dk5bf6
          description: My hosted page description
          sharing_icons: true
        created_at: '2021-06-30T18:02:20.000Z'
        updated_at: '2021-06-30T20:03:16.000Z'
    real_time_stream_update:
      type: object
      description: ''
      properties:
        real_time_stream:
          type: object
          title: real_time_stream
          description: ''
          required:
            - name
          properties:
            name:
              type: string
              description: >-
                A descriptive name for the real-time stream. Maximum 255
                characters.


                <blockquote><strong>Note:</strong>  If you record a real-time
                stream, the name is used to for the recording file name. To
                avoid file management issues in storage, Wowza Video removes or
                replaces special  characters in file names, so the recording
                file name might vary from the name you provided
                here.</blockquote>
              example: ''
            description:
              type: string
              description: An optional description of the real-time stream.
              example: ''
            enable_secure_viewer:
              type: boolean
              description: |-
                Require viewers to pass a security token for playback.

                **Example:** <code>"enable_secure_viewer": false</code>
            expires_on:
              type: string
              description: >-
                The date and time the security token expires. Specify
                **YYYY-MM-DD HH:MM:SS**, where **HH** is a 24-hour clock in UTC.
                If you don't specify **HH:MM:SS**, the token expires at 12AM UTC
                on the specified day.


                Required when *enable_secure_viewer* is **true**.


                **Example:** <code>"expires_on": "2021-10-27 23:08:55
                UTC"</code>
              format: date-time
            region:
              type: string
              description: >-
                An option to set the regional server the stream is distributed
                through. Select the region closest to your broadcast location
                for the most reliable stream. If you select the auto option,
                Wowza Video selects the region based on the publisher's
                location.


                **Default:** phoenix


                **Example:** <code>"region": amsterdam</code>
              example: ''
              enum:
                - phoenix
                - amsterdam
                - singapore
                - bangalore
                - auto
            reference_id:
              type: string
              description: >-
                A unique, alphanumeric ID returned in real-time stream webhook
                payloads. Setting a *reference_id* is useful if you have an ID
                in your system or application you want to associate with
                real-time stream events that trigger webhooks. Maximum 70
                characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|


                You can't use brackets or quotation marks.


                See <a
                href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza
                Video Webhook Event Reference Documentation</a> to learn about
                webhooks.


                Available from version 1.12.


                **Example:** <code>"reference_id": "mySystemID_01"</code>
            player_id:
              type: string
              description: >-
                (Available from version 2.0) The unique alphanumeric string that
                identifies the player configuration to use for this stream. 
                    
                    
                When you pass a player configuration ID, Wowza Video uses that
                player configuration to customize and style the player. If you
                don't pass a value, the default player configuration for the
                account is used.


                Create and edit player configurations in the user interface. The
                ID is on the **General** tab for the player configuration.


                **Default**: Default player configuration


                **Example**: 2205b4e8-b160-43c2-868d-d88698a4e850
            video_poster_image:
              type: string
              description: >-
                The path to a GIF, JPEG, or PNG poster image that appears in the
                player before the stream begins. Poster image files must be 2.5
                MB or smaller.


                **Example:** <code>"video_poster_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>
              example: ''
            logo_image:
              type: string
              description: >-
                A Base64-encoded string representation of a GIF, JPEG, or PNG
                logo  file that appears partially transparent in a corner of the
                player throughout playback. Logo file must be 2.5 MB or smaller.
                    

                **Example:** <code>"logo_image": "[Base64-encoded string
                representation of GIF, JPEG, or PNG file]"</code>   
              example: ''
            logo_position:
              type: string
              description: >-
                The corner of the player in which you want the player logo to
                appear. The default is **top-left**.


                **Example:** <code>"logo_position": "top-right"</code>
              example: ''
              enum:
                - top-left
                - top-right
                - bottom-left
                - bottom-right
            remove_logo_image:
              type: boolean
              description: >-
                If **true**, removes the logo file from the player. The default
                is **false**.


                **Example:** <code>"remove_logo_image": true</code>
              example: true
            remove_video_poster_image:
              type: boolean
              description: |-
                If **true**, removes the poster image. The default is **false**.

                **Example:** <code>"remove_video_poster_image": true</code>
              example: true
            width:
              type: integer
              description: >-
                The width, in pixels, of a fixed-size player. The default is
                **640**.


                **Example:** <code>"width": 640</code>
              example: ''
              format: int32
            hosted_page:
              type: object
              description: Configuration of the hosted page.
              properties:
                title:
                  type: string
                  description: >-
                    A title for the page that appears above the player. Can't
                    include custom HTML, JavaScript, or other tags.


                    **Example:** <code>"title": "My Hosted Page"</code>
                  example: ''
                description:
                  type: string
                  description: >-
                    A description that appears on the hosted page below the
                    player. Can't include custom HTML, JavaScript, or other
                    tags.


                    **Example:** <code>"description": "My Hosted Page
                    Description"</code>
                  example: ''
                logo_image_url:
                  type: string
                  description: >-
                    The path to a GIF, JPEG, or PNG logo file that appears in
                    the upper-left corner of the hosted page. Logo file must be
                    2.5 MB or smaller.
                  example: ''
                sharing_icons:
                  type: boolean
                  description: >-
                    Icons that let viewers share the stream on Facebook,
                    Google+, Twitter, and by email. The default, **true**,
                    includes sharing icons on the hosted page. Specify **false**
                    to omit sharing icons.


                    **Example:** <code>"sharing_icons": false</code>
      example:
        real_time_stream:
          name: MyUpdatedRealTimeStream
          description: This is my first real-time stream.
    Error423:
      type: object
      description: ''
      required:
        - meta
      properties:
        meta:
          type: object
          title: meta
          description: ''
          properties:
            status:
              type: integer
              description: ''
              example: ''
              format: int32
            code:
              type: string
              description: ''
              example: ''
            title:
              type: string
              description: ''
              example: ''
            message:
              type: string
              description: ''
              example: ''
            description:
              type: string
              description: ''
              example: ''
            links:
              type: array
              description: ''
              example: ''
              items: {}
      example:
        Example Response 1:
          meta:
            status: 423
            code: ERR-423-StreamAlreadyStopped
            title: Stream Already Stopped Error
            message: >-
              The request couldn't be processed. The stream has already been
              stopped.
            description: ''
            links: []
    VideoListModel:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the video.
          example: 2aa3343e-2fb5-42c3-8671-b52c24b7c3e2
        name:
          type: string
          description: >-
            The video name. Can be displayed in the player. If not specified, it
            will default to the input file's name.
          example: My video
        description:
          type: string
          description: The video description. Can be displayed in the player.
          example: A new video for my business.
        duration_in_ms:
          type: integer
          description: Duration of the video in milliseconds.
          format: int64
        unpublish:
          type: boolean
          description: >-
            If `true`, the `unpublish_date` is respected and the video will not
            be available after `unpublish_date`. If `false`, the video will not
            be unpublished.
          default: true
        unpublished_at:
          type: string
          description: >-
            Date and time, in ISO-8601 format, when the video no longer is
            available for publishing. After this date, the video is not visible
            in the player if using `ovp-plugin` to request the video.
          format: date-time
          example: '2025-01-01T12:33:22Z'
        published:
          type: boolean
          description: >-
            This field, together with `pubish_date` and `unpublish_date`,
            determines if this video will be visible in public listings such as
            MRSS-feeds, endscreens, and playlists. If `true` and `publish_date`
            and `unpublish_date` allows, the video will be visible.
        published_at:
          type: string
          description: >-
            Date and time, in ISO-8601 format, when the video is available for
            publishing. Before this date, the video is not visible in the player
            if using `ovp-plugin` to request the video.
          format: date-time
          example: '2024-01-01T12:33:22Z'
        tags:
          type: array
          description: An array of tags.
          example:
            - foo
            - bar
          items:
            type: string
            description: An array of tags.
            example:
              - foo
              - bar
        category_id:
          type: string
          description: The unique identifier for the category that the video belongs to.
          default: <The account's default category>
        no_ads:
          type: boolean
          description: |-
            When set to `true`, no ads will be displayed during this video. 

            **Note**: This feature only works for Iframe embeds.
        ad_keywords:
          type: string
          description: >-
            Used for replacing the `ad_keywords` macro in the VAST-tag in any
            player that plays the video. 
          example: special_ads
        created_at:
          type: string
          description: Date and time, in ISO-8601 format, when the video was created.
          format: date-time
          example: '2024-01-01T12:33:22Z'
        updated_at:
          type: string
          description: Date and time, in ISO-8601 format, when the video was updated.
          format: date-time
          example: '2024-01-01T12:33:22Z'
        state:
          type: string
          description: >
            The current state of the video. The state reflects the current
            status of the video files for the video asset. Possible states
            listed below:



            | State | Description |

            |-----------|-------|

            | UPLOADING  | The source file is currently being uploaded or
            waiting to be downloaded by our API. |

            | WAITING_FOR_ENCODER | The source file was successfully downloaded
            by the platform and is in queue to be encoded. |

            | PROCESSING  | Source file for the asset is encoding. The current
            encoding progress can be found on `encoding_progress` property. |

            | FINISHED | The encoding is done and the encoded files can be
            fetched. In this state it's possible to embed the video. |

            | ERROR  | If the platform, for some reason, could not download the
            source file or failed during the encoding process. `error_messsage`
            property can give more information about why it errored.  |

            | DELETED  | The video files have been deleted. Usually the video
            asset have been deleted when this state is reached and because of
            that it's very uncommon to see assets with this state. |
          example: FINISHED
        playback_token_behavior:
          type: string
          description: >-
            Specifies the behavior of token  authentication for the video,
            determining the level of access control.  Use this security when
            distributing sensitive or valuable video content to audiences. It
            ensures that only authorized users can access the  content within
            the intended application.


            **enum:** 


              - **NO_TOKEN:** Video files are accessible and can be downloaded and played by anyone at any time. This is the default.      


              - **BASIC_TOKEN:** The platform automatically creates tokenized video URLs. This setting makes it hard for a viewer
                  to extract the video URL and store it for usage in unintended applications
                  over time since the embed URL, which has the token as part of the URL, 
                  will only be playable for 48 hours. The token autorenews after 48 hours
                  when used in the intended application. 


              - **ADVANCED_TOKEN:** You add the stream's JS embed code and a token to your
                site to provide tokenization. The protections are similar to those for the **Basic
                Token** option except you customize the time limit, geographical limits,
                etc. during token creation. 

                You must either:
                  - Customize and generate a token via the Wowza Video 2.0 API to add
                    to your site before you can use this enum. You'll need to, first, generate a key id to create and 
                    sign the token.

                   - Customize and generate a standard common access token (CAT) through 
                    the means you usually use to create tokens before you can use this enum. You must, first, generate
                    a key id and key via the Wowza Video 2.0 API, to create and sign the token.

              - **FOLLOW_DEFAULT:** The token behavior is based on the **Default Playback Token Behavior**
                setting you select for your Wowza account. See the <a href="https://www.wowza.com/docs/org-setting-page-in-wowza-video" target="_blank">Org Settings page in Wowza Video</a> article
                for where to set this configuration. 
          example: NO_TOKEN
      description: List Video response from the Wowza Video REST API
    Pagination:
      type: object
      properties:
        payload_version:
          type: number
          description: The pagination object version.
          format: double
        total_records:
          type: integer
          description: The total number of records.
          format: int32
          example: 100
        page:
          type: integer
          description: The page number, starting at 1.
          format: int32
          example: 1
          default: 1
        per_page:
          type: integer
          description: The number of records per page.
          format: int32
          example: 10
          default: 20
        total_pages:
          type: integer
          description: The total number of pages.
          format: int32
          example: 2
        page_first_index:
          type: integer
          description: The index of the first record in the response.
          format: int32
          example: 10
        page_last_index:
          type: integer
          description: The index of the last record in the response.
          format: int32
          example: 10
    VideoList:
      type: object
      properties:
        videos:
          type: array
          description: The list of videos
          items:
            $ref: '#/components/schemas/VideoListModel'
        pagination:
          $ref: '#/components/schemas/Pagination'
    DirectInputRequest:
      required:
        - method
      type: object
      properties:
        method:
          type: string
          description: >-
            Method that video file will be provided. Indicates that you'll
            upload a video from local storage. Use the `upload_url` parameter in
            the response to do the actual upload of the video. 
          example: DIRECT
          enum:
            - DIRECT
    FetchInputRequest:
      required:
        - fetch_url
        - method
      type: object
      properties:
        method:
          type: string
          description: >-
            Method that video file will be provided. Fetches the video from the
            URL specified and makes a copy in Wowza Video.
          example: FETCH
          enum:
            - FETCH
        fetch_url:
          type: string
          description: >-
            URL to the video that the platform will download, encode, and serve
            to the player. We accept HTTP and HTTPS addresses. Required if the
            select method is `FETCH`.
          example: https://example.com/video.mp4
        fetch_image_url:
          type: string
          description: >-
            URL to an image the platform will download and serve in the player
            as poster image. We accept HTTP and HTTPS addresses. Required if the
            select method is `FETCH`.
          example: https://example.com/image.jpg
    InputVideoRequest:
      type: object
      description: >-
        Specifies the input method for uploading the video.


        There are two methods to choose from: `DIRECT` or `FETCH`. 


        Expand the `input` description, by clicking the **>** next to the
        `input` label, then click each tab to learn about the methods.


        Learn more:


        - [Upload a video from local
        storage](https://developer.wowza.com/docs/wowza-video/guides/videos/upload-a-video-locally)

        - [Upload a video from external
        storage](https://developer.wowza.com/docs/wowza-video/guides/videos/upload-a-video-external)
      oneOf:
        - $ref: '#/components/schemas/DirectInputRequest'
        - $ref: '#/components/schemas/FetchInputRequest'
    CreateVideoRequestModel:
      required:
        - input
      type: object
      properties:
        video:
          type: object
          title: video
          description: ''
          properties:
            input:
              $ref: '#/components/schemas/InputVideoRequest'
            name:
              type: string
              description: >-
                The video name. Can be displayed in the player. If not
                specified, it will default to the input file's name.
              example: My video
            description:
              type: string
              description: The video description. Can be displayed in the player.
              example: A new video for my business.
            unpublish:
              type: boolean
              description: >-
                If `true`, the `unpublished_at` is respected and the video will
                not be available after `unpublished_at`. If `false`, the video
                will not be unpublished.
              default: true
            unpublished_at:
              type: string
              description: >-
                Date and time, in ISO-8601, format when video no longer is
                available for publishing. After this date, the video is not
                visible in the player if using `ovp-plugin` to request the
                video.
              format: date-time
              example: '2025-01-01T12:33:22Z'
            published:
              type: boolean
              description: >-
                Determines, together with `published_at` and `unpublished_at`,
                if this video will be visible in public listings such as
                MRSS-feeds, endscreens and playlists. If `true`, and if
                `published_at` and `unpublished_at` allows, the video will be
                visible.
            published_at:
              type: string
              description: >-
                Date and time, in ISO-8601 format, when video is available for
                publishing. Before this date the video is not visible in the
                player if using `ovp-plugin` to request the video.
              format: date-time
              example: '2024-01-01T12:33:22Z'
            tags:
              type: array
              description: An array of tags.
              example:
                - foo
                - bar
              items:
                type: string
                description: An array of tags.
                example:
                  - foo
                  - bar
            category_id:
              type: string
              description: >-
                The unique identifier for the category that the video belongs
                to.
              default: <The account's default category>
            ad_insertion_points:
              type: array
              description: >-
                A list of ad insertion points specified for a video. Ad
                insertion points are pre-defined locations in a video where
                advertisements are placed during playback. Ads can be inserted
                at pre-roll (at the beginning of the video), mid-roll (during
                the video), or post-roll (at the end of the video) position(s).



                **Note**: Ad insertion points are only applicable for <a
                href="https://www.wowza.com/docs/get-started-with-advertising-in-wowza-video#client-side-ad-insertion-csai-%C2%A00">client-side
                ad insertion</a>. If you create mid-roll ad insertion points for
                a video, for example, they overwrite any mid-roll ad positions
                created using the <a
                href="https://www.wowza.com/docs/create-a-video-ad-serving-template-vast-ad-schedule-in-wowza-video">Video
                Ad Serving Template ad schedule</a> form. This is because the ad
                insertion points created using the Wowza Video 2.0 API are
                time-specific and more accurate than the percentages chosen in
                the Video Ad Serving Template ad schedule page.
              items:
                type: object
                description: ''
                required:
                  - offset_from_start_in_ms
                properties:
                  offset_from_start_in_ms:
                    type: integer
                    description: >-
                      Specifies the time offset from the start of the video in
                      milliseconds. This parameter determines the point in the
                      video at which the ad break begins.
                    example: 20000
                  description:
                    type: string
                    description: >-
                      The description of the ad position. For example, it can be
                      an ad position in a video such as pre-roll, mid-roll, and
                      post-roll.
                    example: mid-roll
            no_ads:
              type: boolean
              description: |-
                When set to `true`, no ads will be displayed during this video. 

                **Note**: This feature only works for Iframe embeds.
            ad_keywords:
              type: string
              description: >-
                Used for replacing the `ad_keywords` macro in the VAST-tag in
                any player that plays the video. 
              example: special_ads
            playback_token_behavior:
              type: string
              description: >-
                Specifies the behavior of token  authentication for the video,
                determining the level of access control.  Use this security when
                distributing sensitive or valuable video content to audiences.
                It ensures that only authorized users can access the  content
                within the intended application.


                **enum:** 
                  - **NO_TOKEN:** Video files are accessible and can be downloaded and played by anyone at any time. This is the default.
                          
                          
                  - **BASIC_TOKEN:** The platform automatically creates tokenized video URLs. This setting makes it hard for a viewer
                      to extract the video URL and store it for usage in unintended applications
                      over time since the embed URL, which has the token as part of the URL, 
                      will only be playable for 48 hours. The token autorenews after 48 hours
                      when used in the intended application. 



                  - **ADVANCED_TOKEN:** You add the stream's JS embed code and a token to your
                      site to provide tokenization. The protections are similar to those for the **Basic
                      Token** option except you customize the time limit, geographical limits,
                      etc. during token creation. 

                      You must either:
                      - Customize and generate a token via the Wowza Video 2.0 API to add
                             to your site before you can use this enum. You'll need to, first, generate a key id to create and 
                             sign the token.

                      - Customize and generate a standard common access token (CAT) through 
                             the means you usually use to create tokens before you can use this enum. You must, first, generate
                             a key id and key via the Wowza Video 2.0 API, to create and sign the token.

                  - **FOLLOW_DEFAULT:** The token behavior is based on the **Default Playback Token Behavior**
                            setting you select for your Wowza account. See the <a href="https://www.wowza.com/docs/org-setting-page-in-wowza-video" target="_blank">Org Settings page in Wowza Video</a> article
                            for where to set this configuration. 
              example: NO_TOKEN
      description: Create Video request for the Wowza Video REST API
    ImageModel:
      type: object
      properties:
        type:
          type: string
          description: >-
            Image type where valid values are `thumbnail` or `image`.
            `thumbnail` is a smaller image and `image` is larger. Size of the
            images depends on the size of the uploaded image.
          enum:
            - thumbnail
            - image
            - image_0
            - image_1
            - image_2
            - image_3
            - image_4
            - image_5
        url:
          type: string
          description: The URL to the image. We accept HTTP and HTTPS addresses.
          example: https://example.com/image.jpg
      description: >
        Images used together with the video in the platform and the player.


        For platform video images specified in create and update requests, these
        are uploaded and delivered through the platform. For remote assets, the
        specified image URLs are just passed along to the player using the URL
        specified in the request.
    EncodingModel:
      type: object
      properties:
        audio_bitrate_in_kbps:
          type: integer
          description: Audio bitrate in kb/s.
          format: int32
          example: 2300
        audio_channel:
          type: integer
          description: Number of audio channels.
          format: int32
          example: 2
        audio_codec:
          type: string
          description: Audio codec used in the file.
          example: aac
        audio_sample_rate:
          type: integer
          description: >-
            Audio sample rate for this file. Refers to the number of samples of
            audio taken per second, measured in hertz (Hz). It determines the
            audio's frequency range and quality, where a higher sample rate
            captures more detail.
          format: int32
          example: 44100
        height:
          type: integer
          description: Height of the video in pixels.
          format: int32
          example: 1080
        width:
          type: integer
          description: Width of the video in pixels.
          format: int32
          example: 1920
        video_file_url:
          type: string
          description: URL to the video file. We accept HTTP and HTTPS addresses.
          example: https://flowplayer.com/video.mp4
        video_container:
          type: string
          description: Video container type used for this video file.
          example: mp4
        video_codec:
          type: string
          description: Video codec used in this video file.
          example: h264
        total_bitrate_in_kbps:
          type: integer
          description: Total bitrate, video+audio, for the file in kb/s.
          format: int32
          example: 1023
        created_at:
          type: string
          description: Creation timestamp of the file.
          format: date-time
        size_in_bytes:
          type: integer
          description: >-
            Total file size including both audio and video in bytes. For
            segmented files, such as DASH and HLS, this is the complete size
            covering all segments and renditions.
          format: int64
          example: 8325555
      description: Array containing all available Video files and their metadata
    DRMProviderConfigModel:
      type: object
      properties:
        license_server:
          type: string
          description: URL to the license server that can validate the license.
        certificate:
          type: string
          description: >-
            Note: This field is only needed for Fairplay DRM. URL to the
            Fairplay certificate. 
      description: Contains configuration for one DRM provider.
    DRMConfigModel:
      type: object
      properties:
        com.widevine.alpha:
          $ref: '#/components/schemas/DRMProviderConfigModel'
        com.apple.fps.1_0:
          $ref: '#/components/schemas/DRMProviderConfigModel'
        com.microsoft.playready:
          $ref: '#/components/schemas/DRMProviderConfigModel'
      description: Contains all DRM configurations for one video.
    ThumbnailResponse:
      type: object
      properties:
        src:
          type: string
          description: Link to the VTT file.
      description: >-
        Link to the VTT file used by the Thumbnails plug-in. See
        [Thumbnails](https://developer.wowza.com/docs/wowza-flowplayer/plugins/preview-thumbnails/)
        to learn more.
    AnimatedPreviewModel:
      type: object
      properties:
        url:
          type: string
        type:
          type: string
        height:
          type: integer
          description: Height of the animated preview in pixels.
          format: int32
          example: 1080
        width:
          type: integer
          description: Width of the animated preview in pixels.
          format: int32
          example: 1920
      description: The animated previews for the video.
    CreateVideoResponseModel:
      type: object
      properties:
        video:
          type: object
          title: video
          description: ''
          properties:
            id:
              type: string
              description: The unique identifier for the video.
              example: 2aa3343e-2fb5-42c3-8671-b52c24b7c3e2
            name:
              type: string
              description: >-
                The video name. Can be displayed in the player. If not
                specified, it will default to the input file's name.
              example: My video
            description:
              type: string
              description: The video description. Can be displayed in the player.
              example: A new video for my business.
            duration_in_ms:
              type: integer
              description: Duration of the video in milliseconds.
              format: int64
            unpublish:
              type: boolean
              description: >-
                If `true`, the `unpublish_date` is respected and the video will
                not be available after `unpublish_date`. If `false`, the video
                will not be unpublished.
              default: true
            unpublished_at:
              type: string
              description: >-
                Date and time, in ISO-8601 format, when video no longer is
                available for publishing. After this date, the video is not
                visible in the player if using `ovp-plugin` to request the
                video.
              format: date-time
              example: '2025-01-01T12:33:22Z'
            published:
              type: boolean
              description: >-
                This field, together with `pubish_date` and `unpublish_date`,
                determines if this video will be visible in public listings such
                as MRSS-feeds, endscreens and playlists. If `true`, and
                `publish_date` and `unpublish_date` allows, the video will be
                visible.
            published_at:
              type: string
              description: >-
                Date and time, in ISO-8601 format, when video is available for
                publishing. Before this date the video is not visible in the
                player if using `ovp-plugin` to request the video.
              format: date-time
              example: '2024-01-01T12:33:22Z'
            tags:
              type: array
              description: An array of tags.
              example:
                - foo
                - bar
              items:
                type: string
                description: An array of tags.
                example:
                  - foo
                  - bar
            category_id:
              type: string
              description: >-
                The unique identifier for the category that the video belongs
                to.
              default: <The account's default category>
            ad_insertion_points:
              type: array
              description: >-
                A list of ad insertion points specified for a video. Ad
                insertion points are pre-defined locations in a video where
                advertisements are placed during playback. Ads can be inserted
                at pre-roll (at the beginning of the video), mid-roll (during
                the video), or post-roll (at the end of the video) position(s).



                **Note**: Ad insertion points are only applicable for <a
                href="https://www.wowza.com/docs/get-started-with-advertising-in-wowza-video#client-side-ad-insertion-csai-%C2%A00">client-side
                ad insertion</a>. If you create mid-roll ad insertion points for
                a video, for example, they overwrite any mid-roll ad positions
                created using the <a
                href="https://www.wowza.com/docs/create-a-video-ad-serving-template-vast-ad-schedule-in-wowza-video">Video
                Ad Serving Template ad schedule</a> form. This is because the ad
                insertion points created using the Wowza Video 2.0 API are
                time-specific and more accurate than the percentages chosen in
                the Video Ad Serving Template ad schedule page.
              items:
                type: object
                description: ''
                properties:
                  offset_from_start_in_ms:
                    type: integer
                    description: >-
                      Specifies the time offset from the start of the video in
                      milliseconds. This parameter determines the point in the
                      video at which the ad break begins.
                    example: 20000
                  description:
                    type: string
                    description: >-
                      The description of the ad position. For example, it can be
                      an ad position in a video such as pre-roll, mid-roll, and
                      post-roll.
                    example: mid-roll
            no_ads:
              type: boolean
              description: |-
                When set to `true`, no ads will be displayed during this video. 

                **Note**: This feature only works for Iframe embeds.
            ad_keywords:
              type: string
              description: >-
                Used for replacing the `ad_keywords` macro in the VAST-tag in
                any player that plays the video. 
              example: special_ads
            created_at:
              type: string
              description: Date and time, in ISO-8601 format, when video was created.
              format: date-time
              example: '2025-01-01T12:33:22Z'
            updated_at:
              type: string
              description: Date and time, in ISO-8601 format, when video was updated.
              format: date-time
              example: '2024-01-01T12:33:22Z'
            state:
              type: string
              description: >
                The current state of the video. The state reflects the current
                status of the video files for the video asset. Possible states
                listed below:



                | State | Description |

                |-----------|-------|

                | UPLOADING  | The source file is currently being uploaded or
                waiting to be downloaded by our API. |

                | WAITING_FOR_ENCODER | The source file was successfully
                downloaded by the platform and is in queue to be encoded. |

                | PROCESSING  | Source file for the asset is encoding. The
                current encoding progress can be found on `encoding_progress`
                property. |

                | FINISHED | The encoding is done and the encoded files can be
                fetched. In this state it's possible to embed the video. |

                | ERROR  | If the platform, for some reason, could not download
                the source file or failed during the encoding process.
                `error_messsage` property can give more information about why it
                errored.  |

                | DELETED  | The video files have been deleted. Usually the
                Video asset have been deleted when this state is reached and
                because of that it's very uncommon to see assets with this
                state. |
              example: FINISHED
            encoding_progress:
              type: number
              description: >-
                Progress of video encoding, in percentage. The max value, `100`,
                is reached when all video files have been encoded.
              format: double
            upload_progress:
              type: number
              description: >-
                Progress of source file upload, in percentage. If the value is
                `100`, the source file is uploaded.
              format: double
            error_message:
              type: string
              description: >-
                If the platform failed to encode the source file, a message
                describing the error reason will be presented in this property.
            deactivated:
              type: boolean
              description: >-
                If `true`, this video has been deactivated and is no longer
                available for embedding. This usually happens if the account was
                cancelled or trial limits were exceeded.
              default: false
            images:
              type: array
              description: >
                Images used together with the video in the platform and the
                player.


                For platform video images specified in create and update
                requests, these are uploaded and delivered through the platform.
                For remote assets, the specified image URLs are passed along to
                the player using the URL specified in the request.
              items:
                $ref: '#/components/schemas/ImageModel'
            encodings:
              type: array
              description: Array containing all available video files and their metadata.
              items:
                $ref: '#/components/schemas/EncodingModel'
            drm:
              $ref: '#/components/schemas/DRMConfigModel'
            shallow_copy:
              type: boolean
              description: >+
                Whether this video is a shallow copy of another video. A shallow
                copy uses video files controlled by another video, usually on
                another workspace.



                Videos that are shallow copies can't use all features available
                for normal videos. For example, it's not possible to upload a
                new version of the video.



                Another difference is that deleting the video will not delete
                any video files. If the video asset that is the source of the
                copy is deleted, the files will no longer be available for this
                asset.

            shallow_copy_source_id:
              type: string
              description: >-
                If the video is a shallow copy, this field contains the ID of
                the source video entity.


                Note: There are cases where it is not possible to identify the
                source and in those cases this value will be `null`.
            multiple_audio_tracks:
              type: boolean
              description: >-
                If `true`, this video has several different audio tracks
                available for the player. For example, there may be audio tracks
                in different languages.
            audio_only:
              type: boolean
              description: If `true`, this video has no video track but only audio tracks.
            version:
              type: integer
              description: >-
                Tracks the number of times a new source file was uploaded for
                this video asset. For each time a new source file is uploaded,
                the value increases by one.
              format: int32
            thumbnails:
              $ref: '#/components/schemas/ThumbnailResponse'
            animated_previews:
              type: array
              description: The animated previews for the video.
              items:
                $ref: '#/components/schemas/AnimatedPreviewModel'
            playback_token_behavior:
              type: string
              description: >-
                Specifies the behavior of token  authentication for the video,
                determining the level of access control.  Use this security when
                distributing sensitive or valuable video content to audiences.
                It ensures that only authorized users can access the  content
                within the intended application.


                **enum:** 
                  - **NO_TOKEN:** Video files are accessible and can be downloaded and played by anyone at any time. This is the default.
                          
                          
                  - **BASIC_TOKEN:** The platform automatically creates tokenized video URLs. This setting makes it hard for a viewer
                      to extract the video URL and store it for usage in unintended applications
                      over time since the embed URL, which has the token as part of the URL, 
                      will only be playable for 48 hours. The token autorenews after 48 hours
                      when used in the intended application. 



                  - **ADVANCED_TOKEN:** You add the stream's JS embed code and a token to your
                      site to provide tokenization. The protections are similar to those for the **Basic
                      Token** option except you customize the time limit, geographical limits,
                      etc. during token creation. 

                      You must either:
                      - Customize and generate a token via the Wowza Video 2.0 API to add
                             to your site before you can use this enum. You'll need to, first, generate a key id to create and 
                             sign the token.

                      - Customize and generate a standard common access token (CAT) through 
                             the means you usually use to create tokens before you can use this enum. You must, first, generate
                             a key id and key via the Wowza Video 2.0 API, to create and sign the token.

                  - **FOLLOW_DEFAULT:** The token behavior is based on the **Default Playback Token Behavior**
                            setting you select for your Wowza account. See the <a href="https://www.wowza.com/docs/org-setting-page-in-wowza-video" target="_blank">Org Settings page in Wowza Video</a> article
                            for where to set this configuration. 
              example: NO_TOKEN
            upload_url:
              type: string
              description: >-
                If input method `DIRECT` was select, this field contains the
                signed URL that will be used to upload the file.
      description: Video Response from the Wowza Video REST API
    VideoResponseModel:
      type: object
      properties:
        video:
          type: object
          title: video
          description: ''
          properties:
            id:
              type: string
              description: The unique identifier for the video.
              example: 2aa3343e-2fb5-42c3-8671-b52c24b7c3e2
            name:
              type: string
              description: >-
                The video name. Can be displayed in the player. If not
                specified, it will default to the input file's name.
              example: My video
            description:
              type: string
              description: The video description. Can be displayed in the player.
              example: A new video for my business.
            duration_in_ms:
              type: integer
              description: Duration of the video in milliseconds.
              format: int64
            unpublish:
              type: boolean
              description: >-
                If `true`, the `unpublish_date` is respected and the video will
                not be available after `unpublish_date`. If `false`, the video
                will not be unpublished.
              default: true
            unpublished_at:
              type: string
              description: >-
                Date and time, in ISO-8601 format, when video no longer is
                available for publishing. After this date the video is not
                visible in the player if using ovp-plugin to request the video.
              format: date-time
              example: '2025-01-01T12:33:22Z'
            published:
              type: boolean
              description: >-
                This field, together with `publish_date` and `unpublish_date`,
                determines if this video will be visible in public listings such
                as MRSS-feeds, endscreens, and playlists. If `true` and
                `publish_date` and `unpublish_date` allows, the video will be
                visible.
            published_at:
              type: string
              description: >-
                Date and time, in ISO-8601 format, when video is available for
                publishing. Before this date the video is not visible in the
                player if using `ovp-plugin` to request the video.
              format: date-time
              example: '2024-01-01T12:33:22Z'
            tags:
              type: array
              description: An array of tags.
              example:
                - foo
                - bar
              items:
                type: string
                description: An array of tags.
                example:
                  - foo
                  - bar
            category_id:
              type: string
              description: >-
                The unique identifier for the category that the video belongs
                to.
              default: <The account's default category>
            no_ads:
              type: boolean
              description: |-
                When set to `true`, no ads will be displayed during this video. 

                **Note**: This feature only works for Iframe embeds.
            ad_keywords:
              type: string
              description: >-
                Used for replacing the `ad_keywords` macro in the VAST-tag in
                any Player that plays the video. 
              example: special_ads
            created_at:
              type: string
              description: Date and time, in ISO-8601 format, when video was created.
              format: date-time
              example: '2024-01-01T12:33:22Z'
            updated_at:
              type: string
              description: Date and time, in ISO-8601 format, when video was updated.
              format: date-time
              example: '2024-01-01T12:33:22Z'
            state:
              type: string
              description: >
                The current state of the video. The state reflects the current
                status of the video files for the video asset. Possible states
                listed below:



                | State | Description |

                |-----------|-------|

                | UPLOADING  | The source file is currently being uploaded or
                waiting to be downloaded by our API. |

                | WAITING_FOR_ENCODER | The source file was successfully
                downloaded by the platform and is in queue to be encoded. |

                | PROCESSING  | Source file for the asset is encoding. The
                current encoding progress can be found on `encoding_progress`
                property. |

                | FINISHED | The encoding is done and the encoded files can be
                fetched. In this state it's possible to embed the video. |

                | ERROR  | If the platform, for some reason, could not download
                the source file or failed during the encoding process.
                `error_messsage` property can give more information about why it
                errored.  |

                | DELETED  | The video files have been deleted. Usually the
                video asset have been deleted when this state is reached and
                because of that it's very uncommon to see assets with this
                state. |
              example: FINISHED
            encoding_progress:
              type: number
              description: >-
                Progress of video encoding, in percentage. The the max value,
                `100`, is reached when all video files have been encoded.
              format: double
            upload_progress:
              type: number
              description: >-
                Progress of source file upload, in percentage. If the value is
                `100` the source file is uploaded.
              format: double
            error_message:
              type: string
              description: >-
                If the platform failed to encode the source file, a message
                describing the error reason will be presented in this property.
            deactivated:
              type: boolean
              description: >-
                If `true`, this video has been deactivated and is no longer
                available for embedding. This usually happens if the account was
                cancelled or trial limits were exceeded.
              default: false
            images:
              type: array
              description: >
                Images used together with the video in the platform and the
                player.


                For platform video images specified in create and update
                requests, these are uploaded and delivered through the platform.
                For remote assets the specified image URLs are just passed along
                to the player using the URL specified in the request.
              items:
                $ref: '#/components/schemas/ImageModel'
            encodings:
              type: array
              description: Array containing all available video files and their metadata.
              items:
                $ref: '#/components/schemas/EncodingModel'
            drm:
              $ref: '#/components/schemas/DRMConfigModel'
            shallow_copy:
              type: boolean
              description: >+
                Whether this video is a shallow copy of another video. A shallow
                copy uses Video files controlled by another Video, usually on
                another Workspace.



                Videos that are shallow copies can't use all features available
                for normal videos. For example, it's not possible to upload a
                new version of the video.



                Another difference is that deleting the video will not delete
                any video files. If the video asset that is the source of the
                copy is deleted, the files will no longer be available for this
                asset.

            shallow_copy_source_id:
              type: string
              description: >-
                If the video is a shallow copy, this field contains the ID of
                the source Video entity.


                Note: There are cases where it is not possible to identify the
                source and in those cases this value will be `null`.
            multiple_audio_tracks:
              type: boolean
              description: >-
                If `true`, this video has several different audio tracks
                available for the player. For example, there may be audio tracks
                in different languages.
            audio_only:
              type: boolean
              description: If `true`,  this video has no video track but only audio tracks.
            version:
              type: integer
              description: >-
                Tracks the number of times a new source file was uploaded for
                this video asset. For each time a new source file is uploaded,
                the value increases by one.
              format: int32
            thumbnails:
              $ref: '#/components/schemas/ThumbnailResponse'
            ad_insertion_points:
              type: array
              description: >-
                A list of ad insertion points specified for a video. Ad
                insertion points are pre-defined locations in a video where
                advertisements are placed during playback. Ads can be inserted
                at pre-roll (at the beginning of the video), mid-roll (during
                the video), or post-roll (at the end of the video) position(s).




                **Note**: Ad insertion points are only applicable for <a
                href="https://www.wowza.com/docs/get-started-with-advertising-in-wowza-video#client-side-ad-insertion-csai-%C2%A00">client-side
                ad insertion</a>. If you create mid-roll ad insertion points for
                a video, for example, they overwrite any mid-roll ad positions
                created using the <a
                href="https://www.wowza.com/docs/create-a-video-ad-serving-template-vast-ad-schedule-in-wowza-video">Video
                Ad Serving Template ad schedule</a> form. This is because the ad
                insertion points created using the Wowza Video 2.0 API are
                time-specific and more accurate than the percentages chosen in
                the Video Ad Serving Template ad schedule page.
              items:
                type: object
                description: ''
                properties:
                  offset_from_start_in_ms:
                    type: integer
                    description: >-
                      Specifies the time offset from the start of the video in
                      milliseconds. This parameter determines the point in the
                      video at which the ad break begins.
                    example: 20000
                  description:
                    type: string
                    description: >-
                      The description of the ad position. For example, it can be
                      an ad position in a video such as pre-roll, mid-roll, and
                      post-roll.
                    example: mid-roll
            animated_previews:
              type: array
              description: The animated previews for the video.
              items:
                $ref: '#/components/schemas/AnimatedPreviewModel'
            playback_token_behavior:
              type: string
              description: >-
                Specifies the behavior of token  authentication for the video,
                determining the level of access control.  Use this security when
                distributing sensitive or valuable video content to audiences.
                It ensures that only authorized users can access the  content
                within the intended application.


                **enum:** 


                 - **NO_TOKEN:** Video files are accessible and can be downloaded and played by anyone at any time. This is the default.      


                 - **BASIC_TOKEN:**  Video files are accessible and can be downloaded and played by anyone at any time. This setting makes it hard for a viewer
                   to extract the video URL and store it for usage in unintended applications
                   over time since the embed URL, which has the token as part of the URL, 
                   will only be playable for 48 hours. The token autorenews after 48 hours
                   when used in the intended application. 


                 - **ADVANCED_TOKEN:** You add the stream's JS embed code and a token to your
                 site to provide tokenization. The protections are similar to those for the **Basic
                 Token** option except you customize the time limit, geographical limits,
                 etc. during token creation. 

                   You must either:
                     - Customize and generate a token via the Wowza Video 2.0 API to add
                     to your site before you can use this enum. You'll need to, first, generate a key id to create and 
                     sign the token.

                     - Customize and generate a standard common access token (CAT) through 
                     the means you usually use to create tokens before you can use this enum. You must, first, generate
                     a key id and key via the Wowza Video 2.0 API, to create and sign the token.

                 - **FOLLOW_DEFAULT:** The token behavior is based on the **Default Playback Token Behavior**
                 setting you select for your Wowza account. See the <a href="https://www.wowza.com/docs/org-setting-page-in-wowza-video" target="_blank">Org Settings page in Wowza Video</a> article
                 for where to set this configuration. 
              example: NO_TOKEN
            origin:
              type: object
              properties:
                id:
                  type: string
                  description: >-
                    The unique alphanumeric string that identifies the live
                    stream or the real-time stream from which the video
                    originated. Send this ID as the `origin_id` in `GET /videos`
                    to return all the videos associated with this stream.
                  example: wqrs0k75
                type:
                  type: string
                  description: The type of the stream from which the video originated.
                  example: live_stream
                  enum:
                    - live_stream
                    - real_time_stream
                uptime_id:
                  type: string
                  description: >-
                    The unique identifier associated with a specific uptime
                    period of a transcoder.


                    **Note**: `uptime_id` is returned only if the stream from
                    which the video originated is a live stream.
                  example: hvpcp3kn
              description: The origin of the video.
      description: Video Response from the Wowza Video REST API
    ReuploadVideoRequestModel:
      required:
        - input
      type: object
      properties:
        video:
          type: object
          title: video
          description: ''
          properties:
            input:
              $ref: '#/components/schemas/InputVideoRequest'
      description: >-
        Reupload Video request for the Wowza Video REST API. In this request
        it's only possible to add a new version of the video file. To change the
        metadata, use the PATCH endpoint.
    PatchVideoRequestModel:
      type: object
      properties:
        video:
          type: object
          title: video
          description: ''
          properties:
            name:
              type: string
              description: >-
                The video name. Can be displayed in the player. If not
                specified, it will default to the input file's name.
              example: My video
            description:
              type: string
              description: The video description. Can be displayed in the player.
              example: A new video for my business.
            unpublish:
              type: boolean
              description: >-
                If `true` the `unpublished_at` is respected and the video will
                not be available after `unpublished_at`. If `false` the video
                will not be unpublished.
              default: true
            unpublished_at:
              type: string
              description: >-
                Date and time, in ISO-8601, format when video no longer is
                available for publishing. After this date, the video is not
                visible in the player if using `ovp-plugin` to request the
                video.
              format: date-time
              example: '2025-01-01T12:33:22Z'
            published:
              type: boolean
              description: >-
                Determines, together with `published_at` and `unpublished_at`,
                if this video will be visible in public listings such as
                MRSS-feeds, endscreens and playlists. If `true`, and if
                `published_at` and `unpublished_at` allows, the video will be
                visible.
            published_at:
              type: string
              description: >-
                Date and time, in ISO-8601 format, when video is available for
                publishing. Before this date the video is not visible in the
                player if using `ovp-plugin` to request the video.
              format: date-time
              example: '2024-01-01T12:33:22Z'
            tags:
              type: array
              description: An array of tags.
              example:
                - foo
                - bar
              items:
                type: string
                description: An array of tags.
                example:
                  - foo
                  - bar
            category_id:
              type: string
              description: >-
                The unique identifier for the category that the video belongs
                to.
              default: <The account's default category>
            ad_insertion_points:
              type: array
              description: >-
                A list of ad insertion points specified for a video. Ad
                insertion points are pre-defined locations in a video where
                advertisements are placed during playback. Ads can be inserted
                at pre-roll (at the beginning of the video), mid-roll (during
                the video), or post-roll (at the end of the video) position(s).



                **Note**: Ad insertion points are only applicable for <a
                href="https://www.wowza.com/docs/get-started-with-advertising-in-wowza-video#client-side-ad-insertion-csai-%C2%A00">client-side
                ad insertion</a>. If you create mid-roll ad insertion points for
                a video, for example, they overwrite any mid-roll ad positions
                created using the <a
                href="https://www.wowza.com/docs/create-a-video-ad-serving-template-vast-ad-schedule-in-wowza-video">Video
                Ad Serving Template ad schedule</a> form. This is because the ad
                insertion points created using the Wowza Video 2.0 API are
                time-specific and more accurate than the percentages chosen in
                the Video Ad Serving Template ad schedule page.
              items:
                type: object
                description: ''
                required:
                  - offset_from_start_in_ms
                properties:
                  offset_from_start_in_ms:
                    type: integer
                    description: >-
                      Specifies the time offset from the start of the video in
                      milliseconds. This parameter determines the point in the
                      video at which the ad break begins.
                    example: 20000
                  description:
                    type: string
                    description: >-
                      The description of the ad position. For example, it can be
                      an ad position in a video such as pre-roll, mid-roll, and
                      post-roll.
                    example: mid-roll
            no_ads:
              type: boolean
              description: |-
                When set to `true`, no ads will be displayed during this video.

                **Note**: This feature only works for Iframe embeds.
            ad_keywords:
              type: string
              description: >-
                Used for replacing the `ad_keywords` macro in the VAST-tag in
                any player that plays the video. 
              example: special_ads
            playback_token_behavior:
              type: string
              description: >-
                Specifies the behavior of token  authentication for the video,
                determining the level of access control.  Use this security when
                distributing sensitive or valuable video content to audiences.
                It ensures that only authorized users can access the  content
                within the intended application.


                **enum:** 


                 - **NO_TOKEN:** The embed service provided to the player is not tokenized. This is the default.      


                 - **BASIC_TOKEN:** The embed services provided to the player are tokenized. This setting makes it hard for a viewer
                   to extract the video URL and store it for usage in unintended applications
                   over time since the embed URL, which has the token as part of the URL, 
                   will only be playable for 48 hours. The token autorenews after 48 hours
                   when used in the intended application. 


                 - **ADVANCED_TOKEN:** You add the stream's JS embed code and a token to your
                 site to provide tokenization. The protections are similar to those for the **Basic
                 Token** option except you customize the time limit, geographical limits,
                 etc. during token creation. 

                   You must either:
                     - Customize and generate a token via the Wowza Video 2.0 API to add
                     to your site before you can use this enum. You'll need to, first, generate a key id to create and 
                     sign the token.

                      - Customize and generate a standard common access token (CAT) through 
                     the means you usually use to create tokens before you can use this enum. You must, first, generate
                     a key id and key via the Wowza Video 2.0 API, to create and sign the token.

                 - **FOLLOW_DEFAULT:** The token behavior is based on the **Default Playback Token Behavior**
                 setting you select for your Wowza account. See the <a href="https://www.wowza.com/docs/org-setting-page-in-wowza-video" target="_blank">Org Settings page in Wowza Video</a> article
                 for where to set this configuration. 
              example: NO_TOKEN
      description: Patch Video request for the Wowza Video REST API
    CategoryResponse:
      type: object
      properties:
        category:
          type: object
          title: category
          description: ''
          properties:
            id:
              type: string
              description: Unique identifier for the category.
              example: cb65a918-ad7d-406a-80d8-09c9c8d0dbbd
            name:
              type: string
              description: Name of the category.
              example: My first category
            description:
              type: string
              description: A description for the category.
              example: This is a category description.
            parent_id:
              type: string
              description: >-
                Identifier to the parent category if one exists.


                If the category is on top level and no parent exists, the value
                is an empty string.


                **Example**: <code>"parent_id": ""</code>


                If the category is under an existing parent category, the value
                is the id of the parent category.


                **Example**: <code>"parent_id":
                "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"</code>



                **Note**: When updating a category the parent can be removed by
                setting `parent_id` to an empty string.
              example: cb65a918-ad7d-406a-80d8-09c9c8d0dbb
    CategoryListModel:
      type: object
      properties:
        categories:
          type: array
          description: The list of categories.
          items:
            $ref: '#/components/schemas/CategoryResponse'
        pagination:
          $ref: '#/components/schemas/Pagination'
    CategoryRequest:
      type: object
      properties:
        category:
          type: object
          title: category
          description: ''
          properties:
            name:
              type: string
              description: Name of the category.
              example: My first category
            description:
              type: string
              description: A description for the category.
              example: This is a category description
            parent_id:
              type: string
              description: >-
                Identifier to the parent category if one exists.


                If the category is on top level and no parent exists, the value
                is an empty string.


                **Example**: <code>"parent_id": ""</code>


                If the category is under an existing parent category, the value
                is the id of the parent category.


                **Example**: <code>"parent_id":
                "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"</code>



                **Note**: When updating a category the parent can be removed by
                setting `parent_id` to an empty string.
              example: cb65a918-ad7d-406a-80d8-09c9c8d0dbb
    PlaybackTokenKeyResponseModel:
      properties:
        id:
          type: string
          description: >-
            Unique identifier for the playback token key. It will contain the
            organization identifier.
        organization_id:
          type: string
          description: The organization id.
        name:
          type: string
          description: The name of the playback token key for the organization.
        created_at:
          type: string
          description: The playback token creation timestamp.
          format: date-time
          example: '2020-01-01T12:33:22Z'
    ListPlaybackTokenKeyResponseWrapper:
      type: object
      properties:
        playback_token_keys:
          type: array
          description: The list of playback token keys
          items:
            $ref: '#/components/schemas/PlaybackTokenKeyResponseModel'
        pagination:
          $ref: '#/components/schemas/Pagination'
      description: >-
        Playback Token Key Response from the Wowza Video REST API on List
        requests
    CreatePlaybackTokenKeyRequestModel:
      required:
        - name
      type: object
      properties:
        name:
          type: string
          description: The name of the playback token key for the organization.
    CreatePlaybackTokenKeyRequestWrapper:
      required:
        - playbackTokenKey
      type: object
      title: category
      properties:
        playback_token_key:
          $ref: '#/components/schemas/CreatePlaybackTokenKeyRequestModel'
      description: Create Playback Token Key request for the Wowza Video REST API.
    CreatePlaybackTokenKeyResponseModel:
      type: object
      properties:
        id:
          type: string
          description: >-
            The unique identifier for the key for the organization. The id will
            contain the organization id in the key id. 


            If you generate a playback token for advanced token authentication
            by either using the Wowza Video API or by generating a  standard
            common access token (CAT) through the means you usually use to
            create tokens, you'll need to add this key id during token creation
            to sign the token.
        organization_id:
          type: string
          description: The organization id for Wowza Video.
        name:
          type: string
          description: The name of the key for the organization.
        created_at:
          type: string
          description: The key creation timestamp.
          format: date-time
          example: '2025-01-01T12:33:22Z'
        value:
          type: string
          description: >-
            The key value for the key. 


            If you generate a playback token for advanced token authentication
            by creating a standard common access token (CAT) through the means
            you usually use to create tokens, you'll need to add this key value
            during token creation to sign the token.  The key value is only
            returned in this endpoint so keep it in a place that you can access
            it later when you create your playback token. 
    CreatePlaybackTokenKeyResponseWrapper:
      type: object
      properties:
        playback_token_key:
          $ref: '#/components/schemas/CreatePlaybackTokenKeyResponseModel'
      description: Playback token key response from the Wowza Video REST API.
    CatnipClaim:
      type: object
      properties:
        tag:
          type: integer
          description: The tag must be 52 (IPV4 address) or 54 (IPV6 address).
          format: int32
          example: 52
        value:
          type: array
          description: >-
            A two-element array:
              
              
              1. two-element array:
                 - For IPv4, must be < 24. 
                 - For IPv6, must be < 56. 
              2. An object whose keys are byte-indices ("0", "1", ...) and values are the byte values.


            You must have a minimum of two items and can have a maximum of two
            items. 
          items:
            - type: integer
              description: IP-prefix length
            - type: object
              description: Byte-map of the IP-prefix
              additionalProperties:
                type: integer
                description: Byte value (0-255)
          example:
            - 24
            - '0': 188k
              '1': 4
              '2': 23
    GenerateTokenRequest:
      required:
        - exp
        - key_id
      type: object
      properties:
        key_id:
          type: string
          description: >-
            The unique identifier for the id key returned when you used the POST
            /playback_tokens/keys endpoint to create a playback token key. This
            key will sign the token you create.
          example: 51cd5c07-1583-4f5e-bd81-f1aa11510ea9
        exp:
          type: integer
          description: >-
            The expiration time of the token which is the <a
            href="https://www.unixtimestamp.com/" target="_blank">unix
            timestamp</a> in seconds. If the current time is greater than the
            expiration time, the request will be considered invalid.
          format: int64
          example: 1679816499
        nbf:
          type: integer
          description: >-
            The time before which the token must not be accepted for processing
            which is the <a href="https://www.unixtimestamp.com/"
            target="_blank">unix timestamp</a> in seconds.
          format: int64
          example: 1679816499
        iat:
          type: integer
          description: >-
            The issue date of the token which is the <a
            href="https://www.unixtimestamp.com/" target="_blank">unix
            timestamp</a> in seconds.
          format: int64
          example: 1679816499
        iss:
          type: string
          description: The issuer of the token.
          example: my-issuer
        sub:
          type: string
          description: The subject of the token.
          example: subscriber1234
        aud:
          type: string
          description: The audience of the token.
          example: my-audience
        cti:
          type: string
          description: Uniquely identifies a token to help prevent reuse or replay attacks.
          example: unique-token-id
        catnip:
          type: array
          description: >-
            The IP address of the network for which the token was issued. The
            array contains objects with tag and value.  Each object represents a
            catnip claim. 


            The max number of items allowed is 5 and the minimum is zero. 
          items:
            $ref: '#/components/schemas/CatnipClaim'
        catu:
          type: object
          description: >-
            A map of URIs to which the token applies. The maximum number of
            items allowed is five.  The object contains an array of key and
            value. 
          additionalProperties:
            type: array
            description: >-
              The object contains an array of keys and values. 


              - Each key represents a URI component and must be between 0-8. 


              - The value is a list of URIs. The first element of the value
              (match type) must be one of 0,1,2,3. The second element must be a
              string. 


              **Examples based on tables below**: 
               - "1": [0, "token.dotv.wowza.com"]          //Host (exact match)
               - "3": [3, "ssai"]          //Path (contains match)

               
              <details> <summary>Click to expand for the full list of valid
              values</summary>

                | Key |  URI Component | RFC Reference |
                |---|---|---|
                | 0 | Scheme                    | RFC 3986 Section 3.1   |
                | 1 | Host                      | RFC 3986 Section 3.2.2 |
                | 2 | Port                      | RFC 3986 Section 3.2.3 |
                | 3 | Path                      | RFC 3986 Section 3.3   |
                | 4 | Query                     | RFC 3986 Section 3.4   |
                | 5 | Parent Path               | -                      |
                | 6 | Filename                  | -                      |
                | 7 | Stem                      | -                      |
                | 8 | Extension                 | -                      |
              </details>

              <details> <summary>Click to expand for the full list of valid
              values</summary>

                | Value |Match Type          |
                |---|---|
                | 0     | Exact Text Match   |
                | 1     | Prefix Match       |
                | 2     | Suffix Match       |
                | 3     | Contains Match     |
              </details>
        catgeoiso3166:
          type: array
          description: >-
            The ISO3166 country codes from which the token was issued.
            Optionally, followed by a hyphen and a region code. the maximum
            number allowed is five. 
          items:
            type: string
          example:
            - US
            - CA-ON
        catv:
          type: integer
          description: The version of the token. The integer must be 1.
          format: int323
          example: 1
    GenerateTokenResponse:
      type: object
      properties:
        token:
          type: string
          description: >-
            The unique identifier for the playback token. 


            Add this token to your site along with the JS-embed for the video to
            use advanced token authentication. You must also use PATCH
            /videos/{id} to select **ADVANCED_TOKEN** as your authentication
            type for the video after you create the playback token. 
    CreateClipStitch:
      required:
        - mode
        - clips
      type: object
      properties:
        clips:
          type: array
          description: >-
            Represents an array of videos or live streams to be included in the
            clip/stitch operation. If you include only one video or live stream,
            it is clipped based on `start` and `stop`. If you include more than
            one video or live stream, they are clipped based on `start` and
            `stop`, and stitched as one clip.
          items:
            required:
              - id
              - asset_type
            type: object
            title: clips
            properties:
              id:
                type: string
                description: >-
                  Specifies the id of the video or live stream to be clipped
                  and/or stitched.
                example: test
              asset_type:
                type: string
                description: Specifies the asset type
                example: VOD
                enum:
                  - VOD
                  - LIVE_STREAM
              start:
                type: string
                description: >-
                  Starting time of the video segment in 24-hour format with
                  frame precision (HH:MM:SS:FF). If omitted, video starts from
                  the beginning.


                  If you are clipping a live stream, the start time of the
                  stream must be in ISO-8601 format, which is
                  YYYY-MM-DDThh:mm:ssZ.
                example: '00:01:20:00'
              stop:
                type: string
                description: >-
                  Ending time of the video segment in 24-hour format with frame
                  precision (HH:MM:SS:FF). If omitted, video continues until its
                  natural end.


                  If you are clipping a live stream, the end time of the stream
                  must be in ISO-8601 format, which is YYYY-MM-DDThh:mm:ssZ.
                example: '00:05:25:00'
        mode:
          type: string
          description: >-
            Specifies the mode for clipping/stitching operations. In `QUICK`
            mode, clipping can only be performed on segment breakpoints,
            optimizing for speed. For example, for a video or live stream that
            has 8-second interval breakpoint, if you specify a breakpoint
            outside the 8-second interval, the breakpoint is defaulted to the
            closest 8-second breakpoint. If you set your `start` as 00:00:10:00
            (HH:MM:SS:FF), it will set your `start` to 00:00:08:00
            ((HH:MM:SS:FF). In `PRECISE` mode, clipping can be performed on the
            frame level, ensuring higher accuracy but requiring more processing
            time. `PRECISE` mode incurs additional encoding time and cost.


            **Note**: If you are clipping or stitching live streams, the `start`
            and `stop` times must be in ISO-8601 format, which is
            YYYY-MM-DDThh:mm:ssZ.
          example: PRECISE
          enum:
            - QUICK
            - PRECISE
        name:
          type: string
          description: >-
            A descriptive name of the video that's displayed in the player. If
            not specified, it will default to the input file's name.
          example: My video
        description:
          type: string
          description: A description of the video that's displayed in the player.
          example: A new video for my business.
        category_id:
          type: string
          description: The unique identifier for the category that the video belongs to.
          default: <The account's default category>
        published_at:
          type: string
          description: >-
            Date and time, in ISO-8601 format, when video is available for
            publishing. Before this date the video is not visible in the player
            if using
            [ovp-plugin](https://developer.wowza.com/docs/wowza-flowplayer/plugins/wowza-video-platform-integration/)
            to request the video.
          format: date-time
        published:
          type: boolean
          description: >-
            Determines, together with `published_at` and `unpublished_at`, if
            this video will be visible in public listings such as MRSS-feeds,
            endscreens, and playlists. If `true`, and if `published_at` and
            `unpublished_at` allow, the video will be visible.
        unpublish:
          type: boolean
          description: >-
            If `true`, the `unpublished_at` is respected and the video will not
            be available after `unpublished_at`. If `false`, the video will not
            be unpublished.
          default: false
        unpublished_at:
          type: string
          description: >-
            Date and time, in ISO-8601, format when video no longer is available
            for publishing. After this date, the video is not visible in the
            player if using
            [ovp-plugin](https://developer.wowza.com/docs/wowza-flowplayer/plugins/wowza-video-platform-integration/)
            to request the video.
          format: date-time
          example: '2025-01-01T12:33:22Z'
        no_ads:
          type: boolean
          description: |-
            When set to `true`, no ads will be displayed during this video. 

            **Note**: This feature only works for Iframe embeds.
        ad_keywords:
          type: string
          description: >-
            Used for replacing the `ad_keywords` macro in the VAST-tag in any
            player that plays the video.
          example: special_ads
        replace_video_id:
          type: string
          description: >-
            Specifies the video id of the video to be replaced by the
            clip/stitch operation. If the video id is not provided, a new video
            will be created.


            **Caution!** Once you replace the original video with the clip, you
            will no longer be able to retrieve the original video.
    CreateClipStitchRequestModel:
      type: object
      description: Create clip/stitch request for the Wowza Video REST API
      properties:
        clipping:
          type: object
          $ref: '#/components/schemas/CreateClipStitch'
    CreateClipStitchResponseModel:
      type: object
      properties:
        video:
          type: object
          title: video
          description: ''
          properties:
            id:
              type: string
              description: >-
                Specifies the id of the video that is clipped or stitched based
                on the live stream(s) or video(s) sent in the request.
              example: 73a0c613-8972-14cd-9d0c-3c993bddb388
            name:
              type: string
              description: >-
                A descriptive name of the video that's displayed in the player.
                If not specified, it will default to the input file's name.
              example: My video
            description:
              type: string
              description: A description of the video that's displayed in the player.
              example: A new video for my business.
            duration_in_ms:
              type: integer
              description: Duration of the video in milliseconds.
              format: int64
            unpublish:
              type: boolean
              description: >-
                If `true`, the `unpublished_at` is respected and the video will
                not be available after `unpublished_at`. If `false`, the video
                will not be unpublished.
              default: false
            unpublished_at:
              type: string
              description: >-
                Date and time, in ISO-8601 format when video is no longer
                available for publishing. After this date, the video is not
                visible in the player if using
                [ovp-plugin](https://developer.wowza.com/docs/wowza-flowplayer/plugins/wowza-video-platform-integration/)
                to request the video.
              format: date-time
              example: '2020-01-01T12:33:22Z'
            published:
              type: boolean
              description: >-
                Determines, together with `published_at` and `unpublished_at`,
                if this video will be visible in public listings such as
                MRSS-feeds, endscreens, and playlists. If `true`, and if
                `published_at` and `unpublished_at` allow, the video will be
                visible.
            published_at:
              type: string
              description: >-
                Date and time, in ISO-8601 format, when video is available for
                publishing. Before this date the video is not visible in the
                player if using
                [ovp-plugin](https://developer.wowza.com/docs/wowza-flowplayer/plugins/wowza-video-platform-integration/)
                to request the video.
              format: date-time
              example: '2020-01-01T12:33:22Z'
            tags:
              type: array
              description: A list of tags.
              example:
                - foo
                - bar
              items:
                type: string
                description: A list of tags.
                example:
                  - foo
                  - bar
            remote:
              type: boolean
              description: >-
                If true, it indicated that the source file of the video is
                hosted in an external storage location.
              default: false
              example: false
            category_id:
              type: string
              description: >-
                The unique identifier for the category that the video belongs
                to.
              default: <The account's default category>
            no_ads:
              type: boolean
              description: |-
                When set to `true`, no ads will be displayed during this video. 

                **Note**: This feature only works for Iframe embeds.
            ad_keywords:
              type: string
              description: >-
                Used for replacing the `ad_keywords` macro in the VAST-tag in
                any player that plays the video.
              example: special_ads
            created_at:
              type: string
              description: Date and time, in ISO-8601 format, when video was created.
              format: date-time
              example: '2024-05-15T12:33:22Z'
            updated_at:
              type: string
              description: Date and time, in ISO-8601 format, when video was updated.
              format: date-time
              example: '2024-05-16T12:33:22Z'
            state:
              type: string
              description: >-
                The current state of the video. The state reflects the current
                status of the video files for the video asset. Possible states
                listed below:



                | State | Description |

                |-----------|-------|

                | UPLOADING  | The source file is currently being uploaded or
                waiting to be downloaded by our API. |

                | WAITING_FOR_ENCODER | The source file was successfully
                downloaded by the platform and is in queue to be encoded. |

                | PROCESSING  | Source file for the asset is encoding. The
                current encoding progress can be found on `encoding_progress`
                property. |

                | FINISHED | The encoding is done and the encoded files can be
                fetched. In this state it's possible to embed the video. |

                | ERROR  | If the platform, for some reason, could not download
                the source file or failed during the encoding process.
                `error_messsage` property can give more information about why it
                errored.  |

                | DELETED  | The video files have been deleted. Usually the
                Video asset have been deleted when this state is reached and
                because of that it's very uncommon to see assets with this
                state. |
              example: PROCESSING
            encoding_progress:
              type: number
              description: >-
                Progress of video encoding, in percentage. The max value, `100`,
                is reached when all video files have been encoded.
              format: double
            upload_progress:
              type: number
              description: >-
                Progress of source file upload, in percentage. If the value is
                `100`, the source file is uploaded.
              format: double
            error_message:
              type: string
              description: >-
                If the platform failed to encode the source file, a message
                describing the error reason will be presented in this
                property.  
            deactivated:
              type: boolean
              description: >-
                If `true`, this video has been deactivated and is no longer
                available for embedding. This usually happens if the account was
                cancelled or trial limits were exceeded.
              default: false
            images:
              type: array
              description: >-
                Images used together with the video in the platform and the
                player.


                For platform video images specified in create and update
                requests, these are uploaded and delivered through the platform.
                For remote assets, the specified image URLs are passed along to
                the player using the URL specified in the request.
              items:
                $ref: '#/components/schemas/ImageModel'
            encodings:
              type: array
              description: Array containing all available video files and their metadata.
              items:
                $ref: '#/components/schemas/EncodingModel'
            shallow_copy:
              type: boolean
              description: >
                Specifies whether this video is a shallow copy of another video.
                A shallow copy uses video files controlled by another video,
                usually on another workspace.



                Videos that are shallow copies can't use all features available
                for normal videos. For example, it's not possible to upload a
                new version of the video.



                Another difference is that deleting the video will not delete
                any video files. If the video asset that is the source of the
                copy is deleted, the files will no longer be available for this
                asset.
            shallow_copy_source_id:
              type: string
              description: >-
                If the video is a shallow copy, this field contains the ID of
                the source video entity.


                **Note:** There are cases where it is not possible to identify
                the source and in those cases this value will be `null`.
            multiple_audio_tracks:
              type: boolean
              description: >-
                If `true`, this video has several different audio tracks
                available for the player. For example, there may be audio tracks
                in different languages.
            audio_only:
              type: boolean
              description: If `true`, this video has no video track but only audio tracks.
            version:
              type: integer
              description: >-
                Tracks the number of times a new source file was uploaded for
                this video asset. For each time a new source file is uploaded,
                the value increases by one.
              format: int32
