openapi: 3.2.0
info:
  title: Dolby Monitoring API
  version: '1.0'
  description: 'Operations tagged Monitoring across 2 of this provider''s published API definitions: dolby-millicast-api-openapi-original.json, dolby-optiview-live-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.millicast.com
- url: https://api.theo.live/v2
  description: V2 API
- url: https://api.theo.live
  description: Base (for /v1 endpoints)
tags:
- name: Monitoring
paths:
  /api/monitoring/streams:
    get:
      tags:
      - Monitoring
      summary: List Streams
      description: 'List all currently active streams and streams that ended within the last hour, with specific sorting and pagination. If the transcoderId is provided, all streams associated with the current or last active instance will be returned, regardless of the stream end time. If response array is empty, you have reached the end of the list ordering.

        Note: This endpoint requires the LiveMonitoring feature.

        Feed-level stats (frameRate, packetLoss, trackDetails, feedStats) are only available from Stream Details (the single-stream endpoint) and are not returned here.'
      operationId: Monitoring_ListRecentStreams
      parameters:
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 1
          maximum: 2147483647.0
          minimum: 1.0
        x-position: 1
      - name: itemsOnPage
        in: query
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100.0
          minimum: 1.0
        x-position: 2
      - name: sortBy
        in: query
        schema:
          default: Live
          oneOf:
          - $ref: '#/components/schemas/ListSortBy'
        x-position: 3
      - name: isDescending
        in: query
        schema:
          type: boolean
          default: true
        x-position: 4
      - name: isActive
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 5
      - name: cluster
        x-originalName: clusters
        in: query
        style: form
        explode: true
        schema:
          type:
          - array
          - 'null'
          items:
            type: string
        x-position: 6
      - name: isSecure
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 7
      - name: isMultisource
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 8
      - name: hasRedundant
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 9
      - name: searchSubstring
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 10
      - name: isRecordingAllowed
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 11
      - name: isRestreaming
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 12
      - name: transcoderId
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 13
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessListStreams'
              examples:
                list:
                  summary: list
                  value:
                    status: success
                    data:
                      pagination:
                        totalItems: 2
                        totalPages: 1
                        itemsOnPage: 2
                      data:
                      - streamId: Abcde0/restream_feed_1
                        streamName: restream_feed_1
                        clusterId: phx-1
                        clusters:
                        - phx-1
                        secureStream: false
                        isRecordingAllowed: false
                        multisource: true
                        live: true
                        startTime: '2024-06-25T00:42:02.466Z'
                        viewerCount: 0
                        hasRedundant: false
                        restreaming: false
                        feeds:
                        - streamId: Abcde0/restream_feed_1
                          feedId: 9d614662-153f-4904-9a86-859e198d8755
                          clusterId: phx-1
                          serverId: phx-1-dev
                          active: true
                          startTime: '2024-06-25T00:42:02.466Z'
                          isRecordingAllowed: false
                          isRedundant: false
                          tokenId: 1143052
                          client:
                            country: SG
                            city: Singapore
                            continent: AS
                            coordinates:
                            - 1.5078
                            - 103.9918
                            - 20
                            ip: 100.200.100.200
                      - streamId: Abcde0/main_stream
                        streamName: main_stream
                        clusterId: sgp-1
                        clusters:
                        - sgp-1
                        secureStream: false
                        isRecordingAllowed: false
                        multisource: true
                        live: true
                        startTime: '2024-06-25T00:42:01.222Z'
                        viewerCount: 0
                        hasRedundant: false
                        restreaming: true
                        feeds:
                        - streamId: Abcde0/main_stream
                          feedId: 9b8dcce4-cbd9-45fe-a58c-8775f1c6d0d2
                          clusterId: sgp-1
                          serverId: sgp-1-dev
                          active: true
                          startTime: '2024-06-25T00:42:01.222Z'
                          isRecordingAllowed: false
                          isRedundant: false
                          tokenId: 1129104
                          client:
                            country: AU
                            city: Melbourne
                            continent: OC
                            coordinates:
                            - -39.8889
                            - 154.9221
                            - 50
                            sub:
                            - VIC
                            ip: 127.100.100.100
                          restreams:
                          - label: Webcam 1
                            url: rtmp://test.dolby.io/v2/pub
                            active: true
                            started: '2024-06-25T00:42:01.218Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
              examples:
                validation:
                  summary: validation
                  value:
                    status: fail
                    data:
                      errors:
                        page: page must be greater than 0
                        itemsOnPage: ItemsOnPage must be greater than 0 and less 20
        default:
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                general:
                  summary: general
                  value:
                    status: error
                    message: simple error reason
                    code: 500
                    data:
                      additional: other data here (not actual key)
      security:
      - API_Secret: []
    servers:
    - url: https://api.millicast.com
  /api/monitoring/streams/{streamName}:
    get:
      tags:
      - Monitoring
      summary: Stream Details
      description: 'Get stream details by stream name.

        Note: This endpoint requires the LiveMonitoring feature.'
      operationId: Monitoring_GetStream
      parameters:
      - name: streamName
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessStreamDetails'
              examples:
                details:
                  summary: details
                  value:
                    status: success
                    data:
                      streamId: Abcde0/main_stream
                      streamName: main_stream
                      clusterId: sgp-1
                      clusters:
                      - sgp-1
                      secureStream: false
                      isRecordingAllowed: false
                      multisource: false
                      live: false
                      startTime: '2024-06-25T00:42:01.222Z'
                      endTime: '2024-06-25T00:51:33.985Z'
                      viewerCount: 0
                      hasRedundant: false
                      restreaming: false
                      feeds:
                      - streamId: Abcde0/main_stream
                        feedId: 9b8dcce4-cbd9-45fe-a58c-8775f1c6d0d2
                        clusterId: sgp-1
                        serverId: sgp-1-dev
                        active: false
                        startTime: '2024-06-25T00:42:01.222Z'
                        endTime: '2024-06-25T00:51:33.985Z'
                        isRecordingAllowed: false
                        packetLoss: 0
                        isRedundant: false
                        tokenId: 1129104
                        client:
                          country: AU
                          city: Melbourne
                          continent: OC
                          coordinates:
                          - -30.9969
                          - 154.5581
                          - 50
                          sub:
                          - VIC
                          ip: 100.145.200.168
                        restreams:
                        - label: Webcam 1
                          url: rtmp://test.dolby.io:1800/v2/pub
                          active: false
                          started: '2024-06-25T00:42:01.218Z'
                          ended: '2024-06-25T00:51:33.985Z'
                        feedStats:
                        - timestamp: '2024-06-25T00:50:30Z'
                          packetLoss: 0
                        trackDetails: []
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
              examples:
                not found:
                  summary: not found
                  value:
                    status: fail
                    data:
                      message: Stream name DoNotExist not found
        default:
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                general:
                  summary: general
                  value:
                    status: error
                    message: simple error reason
                    code: 500
                    data:
                      additional: other data here (not actual key)
      security:
      - API_Secret: []
    servers:
    - url: https://api.millicast.com
  /api/monitoring/summary:
    get:
      tags:
      - Monitoring
      summary: List Stream Summary
      description: List a summary of all currently active streams and streams that ended within the last hour, with specific sorting and pagination. If the transcoderId is provided, all streams associated with the current or last active instance will be returned, regardless of the stream end time. If response array is empty, you have reached the end of the list ordering. This is a lite version of List Streams which does not include feed details.
      operationId: Monitoring_ListStreamSummary
      parameters:
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 1
          maximum: 2147483647.0
          minimum: 1.0
        x-position: 1
      - name: itemsOnPage
        in: query
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100.0
          minimum: 1.0
        x-position: 2
      - name: sortBy
        in: query
        schema:
          default: Live
          oneOf:
          - $ref: '#/components/schemas/ListSortBy'
        x-position: 3
      - name: isDescending
        in: query
        schema:
          type: boolean
          default: true
        x-position: 4
      - name: isActive
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 5
      - name: cluster
        x-originalName: clusters
        in: query
        style: form
        explode: true
        schema:
          type:
          - array
          - 'null'
          items:
            type: string
        x-position: 6
      - name: isSecure
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 7
      - name: isMultisource
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 8
      - name: searchSubstring
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 9
      - name: isRecordingAllowed
        in: query
        schema:
          type:
          - boolean
          - 'null'
        x-position: 10
      - name: transcoderId
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 11
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessListStreamSummary'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
        default:
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - API_Secret: []
    servers:
    - url: https://api.millicast.com
  /api/monitoring/summary/{streamName}:
    get:
      tags:
      - Monitoring
      summary: Stream Summary
      description: Get stream summary by stream name. This is a lite version of Stream Details which does not include feed details.
      operationId: Monitoring_GetStreamSummary
      parameters:
      - name: streamName
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessStreamSummary'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailResponse'
        default:
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - API_Secret: []
    servers:
    - url: https://api.millicast.com
  /monitoring/channels/{channelId}:
    get:
      tags:
      - Monitoring
      operationId: get-channel-monitoring
      summary: Get monitoring data for a channel
      description: Returns monitoring data for a specific channel including status of ingests, engines, and distributions.
      x-mcp:
        description: 'Get the current health/monitoring snapshot of a channel: engine and ingest state plus stream quality indicators. Use this to diagnose why a channel is not playing. Requires the liveMonitoring feature.'
      parameters:
      - schema:
          type: string
          description: Channel ID
        required: true
        description: Channel ID
        name: channelId
        in: path
      responses:
        '200':
          description: Channel monitoring data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelMonitoringResult'
        '404':
          description: Channel not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringError'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringError'
      security:
      - BasicAuth: []
    servers:
    - url: https://api.theo.live/v2
      description: V2 API
    - url: https://api.theo.live
      description: Base (for /v1 endpoints)
  /monitoring/ingests/{ingestId}:
    get:
      tags:
      - Monitoring
      operationId: get-ingest-monitoring
      summary: Get detailed monitoring data for an ingest
      description: Returns monitoring data for a specific ingest including time-series metrics like packet loss, RTT, and bitrate.
      parameters:
      - schema:
          type: string
          description: Ingest ID
        required: true
        description: Ingest ID
        name: ingestId
        in: path
      - schema:
          type: string
          description: 'Start time in ISO 8601 format. Default: 1 minute ago. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
          example: '2026-03-20T00:00:00Z'
        required: false
        description: 'Start time in ISO 8601 format. Default: 1 minute ago. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
        name: start
        in: query
      - schema:
          type: string
          description: 'End time in ISO 8601 format. Default: now. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
          example: '2026-03-20T00:01:00Z'
        required: false
        description: 'End time in ISO 8601 format. Default: now. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
        name: end
        in: query
      responses:
        '200':
          description: Ingest monitoring data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestMonitoringResult'
        '404':
          description: Ingest not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringError'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringError'
      security:
      - BasicAuth: []
    servers:
    - url: https://api.theo.live/v2
      description: V2 API
    - url: https://api.theo.live
      description: Base (for /v1 endpoints)
  /monitoring/engines/{engineId}:
    get:
      tags:
      - Monitoring
      operationId: get-engine-monitoring
      summary: Get detailed monitoring data for an engine
      description: Returns monitoring data for a specific engine including rendition metrics.
      parameters:
      - schema:
          type: string
          description: Engine ID
        required: true
        description: Engine ID
        name: engineId
        in: path
      - schema:
          type: string
          description: 'Start time in ISO 8601 format. Default: 1 minute ago. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
          example: '2026-03-20T00:00:00Z'
        required: false
        description: 'Start time in ISO 8601 format. Default: 1 minute ago. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
        name: start
        in: query
      - schema:
          type: string
          description: 'End time in ISO 8601 format. Default: now. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
          example: '2026-03-20T00:01:00Z'
        required: false
        description: 'End time in ISO 8601 format. Default: now. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
        name: end
        in: query
      responses:
        '200':
          description: Engine monitoring data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineMonitoringResult'
        '404':
          description: Engine not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringError'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringError'
      security:
      - BasicAuth: []
    servers:
    - url: https://api.theo.live/v2
      description: V2 API
    - url: https://api.theo.live
      description: Base (for /v1 endpoints)
  /monitoring/channels/{channelId}/ingests:
    get:
      tags:
      - Monitoring
      operationId: get-channel-ingests-monitoring
      summary: Get detailed ingest monitoring data for a channel
      description: Returns channel metadata along with detailed monitoring data for all ingests belonging to the channel.
      parameters:
      - schema:
          type: string
          description: Channel ID
        required: true
        description: Channel ID
        name: channelId
        in: path
      - schema:
          type: string
          description: 'Start time in ISO 8601 format. Default: 1 minute ago. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
          example: '2026-03-20T00:00:00Z'
        required: false
        description: 'Start time in ISO 8601 format. Default: 1 minute ago. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
        name: start
        in: query
      - schema:
          type: string
          description: 'End time in ISO 8601 format. Default: now. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
          example: '2026-03-20T00:01:00Z'
        required: false
        description: 'End time in ISO 8601 format. Default: now. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
        name: end
        in: query
      responses:
        '200':
          description: Channel ingests monitoring data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelIngestsMonitoringResult'
        '404':
          description: Channel not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringError'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringError'
      security:
      - BasicAuth: []
    servers:
    - url: https://api.theo.live/v2
      description: V2 API
    - url: https://api.theo.live
      description: Base (for /v1 endpoints)
  /monitoring/channels/{channelId}/engines:
    get:
      tags:
      - Monitoring
      operationId: get-channel-engines-monitoring
      summary: Get detailed engine monitoring data for a channel
      description: Returns channel metadata along with detailed monitoring data for all engines belonging to the channel.
      parameters:
      - schema:
          type: string
          description: Channel ID
        required: true
        description: Channel ID
        name: channelId
        in: path
      - schema:
          type: string
          description: 'Start time in ISO 8601 format. Default: 1 minute ago. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
          example: '2026-03-20T00:00:00Z'
        required: false
        description: 'Start time in ISO 8601 format. Default: 1 minute ago. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
        name: start
        in: query
      - schema:
          type: string
          description: 'End time in ISO 8601 format. Default: now. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
          example: '2026-03-20T00:01:00Z'
        required: false
        description: 'End time in ISO 8601 format. Default: now. Must be within 5 minutes of the current time. Start and end must be at most 1 minute apart.'
        name: end
        in: query
      responses:
        '200':
          description: Channel engines monitoring data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelEnginesMonitoringResult'
        '404':
          description: Channel not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringError'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringError'
      security:
      - BasicAuth: []
    servers:
    - url: https://api.theo.live/v2
      description: V2 API
    - url: https://api.theo.live
      description: Base (for /v1 endpoints)
components:
  schemas:
    FeedSummary:
      type: object
      additionalProperties: false
      properties:
        streamId:
          type: string
        feedId:
          type: string
        clusterId:
          type: string
        sourceId:
          type: string
        simulcastId:
          type: string
        serverId:
          type: string
        active:
          type: boolean
        startTime:
          type: string
          format: date-time
        endTime:
          type:
          - string
          - 'null'
          format: date-time
        isRecordingAllowed:
          type: boolean
        isRedundant:
          type:
          - boolean
          - 'null'
        priority:
          type:
          - integer
          - 'null'
          format: int32
        tokenId:
          type: integer
          format: int32
        client:
          $ref: '#/components/schemas/GeoClient'
        restreams:
          type: array
          items:
            $ref: '#/components/schemas/RestreamDetails'
    PaginatedResponseOfStreamSummary:
      type: object
      additionalProperties: false
      properties:
        pagination:
          oneOf:
          - $ref: '#/components/schemas/PaginationData'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/StreamSummary'
    PaginationData:
      type: object
      additionalProperties: false
      properties:
        totalItems:
          type: integer
          format: int32
        totalPages:
          type: integer
          format: int32
        itemsOnPage:
          type: integer
          format: int32
    StreamDetails:
      type: object
      additionalProperties: false
      properties:
        streamId:
          type: string
        streamName:
          type: string
        clusterId:
          type: string
        clusters:
          type: array
          items:
            type: string
        secureStream:
          type: boolean
        isRecordingAllowed:
          type: boolean
        multisource:
          type: boolean
        live:
          type: boolean
        startTime:
          type: string
          format: date-time
        endTime:
          type:
          - string
          - 'null'
          format: date-time
        viewerCount:
          type: integer
          format: int64
        hasRedundant:
          type:
          - boolean
          - 'null'
        restreaming:
          type:
          - boolean
          - 'null'
        feeds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FeedDetails'
    SuccessListStreams:
      type: object
      additionalProperties: false
      required:
      - status
      - data
      properties:
        status:
          type: string
          default: success
          minLength: 1
        data:
          $ref: '#/components/schemas/PaginatedResponseOfStreamSummary'
    ListSortBy:
      type: string
      description: ''
      x-enumNames:
      - StreamId
      - Cluster
      - StartTime
      - Duration
      - Live
      - ViewerCount
      - Restream
      enum:
      - StreamId
      - Cluster
      - StartTime
      - Duration
      - Live
      - ViewerCount
      - Restream
    Resolution:
      type: object
      additionalProperties: false
      properties:
        height:
          type: number
          format: double
        width:
          type: number
          format: double
    SuccessStreamDetails:
      type: object
      additionalProperties: false
      required:
      - status
      - data
      properties:
        status:
          type: string
          default: success
          minLength: 1
        data:
          $ref: '#/components/schemas/StreamDetails'
    SuccessListStreamSummary:
      type: object
      additionalProperties: false
      required:
      - status
      - data
      properties:
        status:
          type: string
          default: success
          minLength: 1
        data:
          $ref: '#/components/schemas/PaginatedResponseOfStreamBaseSummary'
    SuccessStreamSummary:
      type: object
      additionalProperties: false
      required:
      - status
      - data
      properties:
        status:
          type: string
          default: success
          minLength: 1
        data:
          $ref: '#/components/schemas/StreamBaseSummary'
    TrackDetails:
      type: object
      additionalProperties: false
      properties:
        trackId:
          type: string
        encodingDetails:
          type: array
          items:
            $ref: '#/components/schemas/EncodingDetails'
    EncodingDetails:
      type: object
      additionalProperties: false
      properties:
        encodingId:
          type: string
        iFrameRate:
          type:
          - number
          - 'null'
          format: double
        bFrameRate:
          type:
          - number
          - 'null'
          format: double
        pFrameRate:
          type:
          - number
          - 'null'
          format: double
        encodingStats:
          type: array
          items:
            $ref: '#/components/schemas/EncodingStats'
    GeoClient:
      type: object
      additionalProperties: false
      properties:
        country:
          type: string
        city:
          type: string
        continent:
          type: string
        coordinates:
          type: array
          items:
            type: number
            format: decimal
        sub:
          type: array
          items:
            type: string
        ip:
          type: string
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
      - status
      - message
      properties:
        status:
          type: string
          default: error
          minLength: 1
        message:
          type: string
          minLength: 1
        code:
          type:
          - integer
          - 'null'
          format: int32
        data: {}
    RestreamEvent:
      type: object
      additionalProperties: false
      properties:
        started:
          type: string
          format: date-time
        ended:
          type:
          - string
          - 'null'
          format: date-time
        error:
          type: string
    StreamSummary:
      type: object
      additionalProperties: false
      properties:
        streamId:
          type: string
        streamName:
          type: string
        clusterId:
          type: string
        clusters:
          type: array
          items:
            type: string
        secureStream:
          type: boolean
        isRecordingAllowed:
          type: boolean
        multisource:
          type: boolean
        live:
          type: boolean
        startTime:
          type: string
          format: date-time
        endTime:
          type:
          - string
          - 'null'
          format: date-time
        viewerCount:
          type: integer
          format: int64
        hasRedundant:
          type:
          - boolean
          - 'null'
        restreaming:
          type:
          - boolean
          - 'null'
        feeds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FeedSummary'
    EncodingStats:
      type: object
      additionalProperties: false
      properties:
        timestamp:
          type: string
          format: date-time
        resolution:
          oneOf:
          - $ref: '#/components/schemas/Resolution'
        bitRate:
          $ref: '#/components/schemas/Bitrate'
        videoCodec:
          type: string
        audioCodec:
          type: string
        frames:
          type:
          - number
          - 'null'
          format: decimal
        rtt:
          type:
          - number
          - 'null'
          format: double
        bufferTime:
          type:
          - number
          - 'null'
          format: double
        bFrames:
          type:
          - number
          - 'null'
          format: double
    RestreamDetails:
      type: object
      additionalProperties: false
      properties:
        label:
          type: string
        index:
          type: integer
          format: int32
        url:
          type: string
        active:
          type: boolean
        events:
          type: array
          items:
            $ref: '#/components/schemas/RestreamEvent'
    StreamBaseSummary:
      type: object
      additionalProperties: false
      properties:
        streamId:
          type:
          - string
          - 'null'
          description: The identifier of the stream.
        streamName:
          type:
          - string
          - 'null'
          description: The name of the stream.
        clusterId:
          type:
          - string
          - 'null'
          description: The identifier of the cluster where the stream was first connected to.
        clusters:
          type:
          - array
          - 'null'
          description: The list of clusters where the stream is published to.
          items:
            type: string
        secureStream:
          type: boolean
          description: Flag indicating whether the stream is secured.
        isRecordingAllowed:
          type: boolean
          description: Flag indicating whether recording is allowed for the stream.
        multisource:
          type: boolean
          description: Flag indicating whether the stream allows multiple sources.
        live:
          type: boolean
          description: Flag indicating whether the stream is live.
        startTime:
          type: string
          description: The time when the stream has started.
          format: date-time
        endTime:
          type:
          - string
          - 'null'
          description: The time when the stream has ended.
          format: date-time
        viewerCount:
          type: integer
          description: The number of viewers watching the stream.
          format: int64
    FeedStats:
      type: object
      additionalProperties: false
      properties:
        timestamp:
          type: string
          format: date-time
        packetLoss:
          type: number
          description: Packet loss percentage over last five seconds
          format: double
    FeedDetails:
      type: object
      additionalProperties: false
      properties:
        streamId:
          type: string
        feedId:
          type: string
        clusterId:
          type: string
        sourceId:
          type: string
        simulcastId:
          type: string
        serverId:
          type: string
        active:
          type: boolean
        startTime:
          type: string
          format: date-time
        endTime:
          type:
          - string
          - 'null'
          format: date-time
        isRecordingAllowed:
          type: boolean
        packetLoss:
          type: number
          description: Packet loss percentage over last five minutes
          format: double
        isRedundant:
          type:
          - boolean
          - 'null'
        priority:
          type:
          - integer
          - 'null'
          format: int32
        frameRate:
          type: number
          format: decimal
        type:
          type: string
        tokenId:
          type: integer
          format: int32
        client:
          $ref: '#/components/schemas/GeoClient'
        restreams:
          type: array
          items:
            $ref: '#/components/schemas/RestreamDetails'
        feedStats:
          type: array
          items:
            $ref: '#/components/schemas/FeedStats'
        trackDetails:
          type: array
          items:
            $ref: '#/components/schemas/TrackDetails'
    Bitrate:
      type: object
      additionalProperties: false
      properties:
        audioBitrate:
          type: number
          format: double
        videoBitrate:
          type: number
          format: double
    PaginatedResponseOfStreamBaseSummary:
      type: object
      additionalProperties: false
      properties:
        pagination:
          oneOf:
          - $ref: '#/components/schemas/PaginationData'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/StreamBaseSummary'
    FailResponse:
      type: object
      additionalProperties: false
      required:
      - status
      - data
      properties:
        status:
          type: string
          default: fail
          minLength: 1
        data: {}
    EngineRenditionMetricDataPoint:
      type: object
      properties:
        time:
          type: string
          description: Timestamp in ISO 8601 format
        framerate:
          type: number
          description: Framerate in fps
        bitrate:
          type: number
          description: Bitrate in bps
      required:
      - time
      - framerate
      - bitrate
    ChannelIngestsMonitoringData:
      type: object
      properties:
        id:
          type: string
          description: Channel ID
        name:
          type: string
          description: Channel name
        status:
          type: string
          description: Channel status derived from engine states
        ingests:
          type: array
          items:
            $ref: '#/components/schemas/IngestMonitoringData'
          description: List of ingests with detailed monitoring data
      required:
      - id
      - name
      - status
      - ingests
    EngineMonitoringResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EngineMonitoringData'
      required:
      - data
    ChannelMonitoringResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ChannelMonitoringData'
      required:
      - data
    IngestMonitoringStatus:
      type: object
      properties:
        id:
          type: string
          description: Ingest ID
        protocol:
          type: string
          description: Ingest protocol
          example: srt-push
      required:
      - id
      - protocol
    EngineMonitoringData:
      type: object
      properties:
        id:
          type: string
          description: Engine ID
        status:
          type: string
          description: Engine status
        renditions:
          type: array
          items:
            $ref: '#/components/schemas/EngineRenditionData'
          description: List of renditions with metrics
      required:
      - id
      - status
    ChannelMonitoringData:
      type: object
      properties:
        id:
          type: string
          description: Channel ID
        name:
          type: string
          description: Channel name
        status:
          type: string
          description: Channel status derived from engine states
        ingests:
          type: array
          items:
            $ref: '#/components/schemas/IngestMonitoringStatus'
          description: List of ingests with status
        engines:
          type: array
          items:
            $ref: '#/components/schemas/EngineMonitoringStatus'
          description: List of engines with status
        distributions:
          type: array
          items:
            $ref: '#/components/schemas/DistributionMonitoringStatus'
          description: List of distributions with status
      required:
      - id
      - name
      - status
      - ingests
      - engines
      - distributions
    IngestMetricDataPoint:
      type: object
      properties:
        time:
          type: string
          description: Timestamp in ISO 8601 format
        packetLoss:
          type: number
          description: Packet loss count
        rtt:
          type: number
          description: Round-trip time in milliseconds
        bitrate:
          type: object
          properties:
            total:
              type: number
              description: Total bitrate in bps
          required:
          - total
        location:
          type: object
          properties:
            ip:
              type: string
              description: Remote IP address
            region:
              type: string
              description: Ingest region
          required:
          - ip
          - region
      required:
      - time
      - packetLoss
      - rtt
      - bitrate
      - location
    EngineMonitoringStatus:
      type: object
      properties:
        id:
          type: string
          description: Engine ID
        status:
          type: string
          description: Engine status
        renditions:
          type: number
          description: Number of renditions
        bitrate:
          type: number
          description: Total bitrate
      required:
      - id
      - status
    IngestMonitoringData:
      type: object
      properties:
        id:
          type: string
          description: Ingest ID
        status:
          type: string
          description: Ingest status
        protocol:
          type: string
          description: Ingest protocol
          example: srt-push
        started:
          type: string
          description: Connection start time in ISO 8601 format
        uptime:
          type: number
          description: Uptime in seconds
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/IngestMetricDataPoint'
          description: Time-series metric data points
      required:
      - id
      - status
      - protocol
    ChannelIngestsMonitoringResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ChannelIngestsMonitoringData'
      required:
      - data
    DistributionMonitoringStatus:
      type: object
      properties:
        id:
          type: string
          description: Distribution ID
        status:
          type: string
          description: Distribution status (enabled/disabled)
      required:
      - id
      - status
    EngineRenditionData:
      type: object
      properties:
        name:
          type: string
          description: Rendition name
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/EngineRenditionMetricDataPoint'
          description: Time-series metric data points
      required:
      - name
      - metrics
    ChannelEnginesMonitoringData:
      type: object
      properties:
        id:
          type: string
          description: Channel ID
        name:
          type: string
          description: Channel name
        status:
          type: string
          description: Channel status derived from engine states
        engines:
          type: array
          items:
            $ref: '#/components/schemas/EngineMonitoringData'
          description: List of engines with detailed monitoring data
      required:
      - id
      - name
      - status
      - engines
    ChannelEnginesMonitoringResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ChannelEnginesMonitoringData'
      required:
      - data
    MonitoringError:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
      required:
      - code
      - message
    IngestMonitoringResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/IngestMonitoringData'
      required:
      - data
  securitySchemes:
    API_Secret:
      type: http
      description: '### Usage

        #### Acquire secret from dashboard.

        * Login to the streaming dashboard

        * On the left menu, click on Settings

        * Navigate to the Security tab''s sub section API Secrets

        1. "+ Create" to generate a new named API Secret if needed

        2. Click on the copy button or the reveal button to access a previously created API Secret


        ![](../assets/api_secret.png "Find API Secret")'
      scheme: bearer
    BasicAuth:
      type: http
      scheme: basic
x-refined-from:
- dolby-millicast-api-openapi-original.json
- dolby-optiview-live-openapi-original.json
x-generator: NSwag v14.6.3.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))
x-code-samples-replace: {}