openapi: 3.2.0
info:
  title: Istreamplanet Transcoder Telemetry API
  version: v1.52.0
  contact:
    email: live-control-plane-devs@wbd.com
    name: ChannelAPI Support
    url: https://warnermedia.enterprise.slack.com/archives/C0648UND8SD
  description: 'Operations tagged Transcoder Telemetry across 2 of this provider''s published API definitions: istreamplanet-aventus-channels-openapi.json, istreamplanet-aventus-channels-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: prod
  url: https://api.istreamplanet.com
security:
- authcode: []
  m2m: []
tags:
- name: Transcoder Telemetry
paths:
  /v2/scte-history:
    get:
      description: Returns the history of out-of-band SCTE-35 messages received by the transcoder for all channels.
      operationId: list-raw-scte-history
      parameters:
      - description: ISO 8601 UTC timestamp for start range of date filtering
        explode: false
        in: query
        name: from
        schema:
          description: ISO 8601 UTC timestamp for start range of date filtering
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRawSCTEHistoryResponseBody'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Found
        '413':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Request Entity Too Large
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
        '501':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Implemented
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Service Unavailable
      summary: Get SCTE-35 History
      tags:
      - Transcoder Telemetry
    servers:
    - description: prod
      url: https://api.istreamplanet.com
  /v2/{org}/channels/{channel-id}/content-segment-history:
    get:
      description: Returns content segment history for a channel.
      operationId: list-content-segment-history
      parameters:
      - description: Organization name
        in: path
        name: org
        required: true
        schema:
          description: Organization name
          type: string
      - description: Unique channel identifier
        in: path
        name: channel-id
        required: true
        schema:
          description: Unique channel identifier
          maxLength: 60
          pattern: ^([a-z0-9]+(-*[a-z0-9]+)*)$
          type: string
      - description: ISO 8601 UTC timestamp for start range of date filtering
        explode: false
        in: query
        name: from
        schema:
          description: ISO 8601 UTC timestamp for start range of date filtering
          format: date-time
          type: string
      - description: ISO 8601 UTC timestamp for end range of date filtering
        explode: false
        in: query
        name: to
        schema:
          description: ISO 8601 UTC timestamp for end range of date filtering
          format: date-time
          type: string
      - description: Filter by segment types. If not specified, all segment types are returned. Corresponds to the ChannelProto channeldoc.SignalingSegment ENUM names.
        explode: false
        in: query
        name: segment_types
        schema:
          description: Filter by segment types. If not specified, all segment types are returned. Corresponds to the ChannelProto channeldoc.SignalingSegment ENUM names.
          examples:
          - - PROGRAM
          items:
            type: string
          minItems: 1
          type:
          - array
          - 'null'
      - description: Type part of the UPID. Required when upid_id is provided.
        explode: false
        in: query
        name: upid_type
        schema:
          description: Type part of the UPID. Required when upid_id is provided.
          examples:
          - 12
          format: int32
          type: integer
      - description: ID part of the UPID. Accepts plain text and hex-encoded values prefixed with a 0x. Required when upid_type is provided
        explode: false
        in: query
        name: upid_id
        schema:
          description: ID part of the UPID. Accepts plain text and hex-encoded values prefixed with a 0x. Required when upid_type is provided
          examples:
          - DISC279973-169
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListContentSegmentHistoryResponseBody'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Found
        '413':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Request Entity Too Large
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
        '501':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Implemented
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Service Unavailable
      summary: List Channel Content Segments History
      tags:
      - Transcoder Telemetry
    servers:
    - description: prod
      url: https://api.istreamplanet.com
  /v2/{org}/channels/{channel-id}/cost-report:
    get:
      description: Returns a Cost Report for a channel.
      operationId: get-channel-cost-report
      parameters:
      - description: Organization name
        in: path
        name: org
        required: true
        schema:
          description: Organization name
          type: string
      - description: Unique channel identifier
        in: path
        name: channel-id
        required: true
        schema:
          description: Unique channel identifier
          maxLength: 60
          pattern: ^([a-z0-9]+(-*[a-z0-9]+)*)$
          type: string
      - description: ISO 8601 UTC timestamp for start range of date filtering
        explode: false
        in: query
        name: from
        schema:
          description: ISO 8601 UTC timestamp for start range of date filtering
          format: date-time
          type: string
      - description: ISO 8601 UTC timestamp for end range of date filtering
        explode: false
        in: query
        name: to
        schema:
          description: ISO 8601 UTC timestamp for end range of date filtering
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetChannelCostReportResponseBody'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Found
        '413':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Request Entity Too Large
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
        '501':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Implemented
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Service Unavailable
      summary: Get Channel Cost Report
      tags:
      - Transcoder Telemetry
    servers:
    - description: prod
      url: https://api.istreamplanet.com
  /v2/{org}/channels/{channel-id}/scte-history:
    get:
      description: Returns the history of out-of-band SCTE-35 messages received by the transcoder for a channel.
      operationId: list-raw-scte-history-by-channel
      parameters:
      - description: Organization name
        in: path
        name: org
        required: true
        schema:
          description: Organization name
          type: string
      - description: Unique channel identifier
        in: path
        name: channel-id
        required: true
        schema:
          description: Unique channel identifier
          maxLength: 60
          pattern: ^([a-z0-9]+(-*[a-z0-9]+)*)$
          type: string
      - description: ISO 8601 UTC timestamp for start range of date filtering
        explode: false
        in: query
        name: from
        schema:
          description: ISO 8601 UTC timestamp for start range of date filtering
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRawSCTEHistoryByChannelResponseBody'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Found
        '413':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Request Entity Too Large
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
        '501':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Implemented
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Service Unavailable
      summary: Get Channel SCTE-35 History
      tags:
      - Transcoder Telemetry
    servers:
    - description: prod
      url: https://api.istreamplanet.com
  /v2/{org}/cost-report:
    get:
      description: Returns Cost Reports for channels in an organization.
      operationId: list-organization-cost-reports
      parameters:
      - description: Organization name
        in: path
        name: org
        required: true
        schema:
          description: Organization name
          type: string
      - description: ISO 8601 UTC timestamp for start range of date filtering
        explode: false
        in: query
        name: from
        schema:
          description: ISO 8601 UTC timestamp for start range of date filtering
          format: date-time
          type: string
      - description: ISO 8601 UTC timestamp for end range of date filtering
        explode: false
        in: query
        name: to
        schema:
          description: ISO 8601 UTC timestamp for end range of date filtering
          format: date-time
          type: string
      - description: Current page cursor
        explode: false
        in: query
        name: cursor
        schema:
          description: Current page cursor
          type: string
      - description: Number of items to return
        explode: false
        in: query
        name: page_size
        schema:
          default: 100
          description: Number of items to return
          format: int32
          maximum: 100
          minimum: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ChannelCostReport'
                type:
                - array
                - 'null'
          description: OK
          headers:
            Link:
              schema:
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Found
        '413':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Request Entity Too Large
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
        '501':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Implemented
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Service Unavailable
      summary: List Organization Cost Reports
      tags:
      - Transcoder Telemetry
    servers:
    - description: prod
      url: https://api.istreamplanet.com
components:
  schemas:
    TranscoderRawSCTE35:
      additionalProperties: false
      properties:
        header:
          $ref: '#/components/schemas/TranscoderHeader'
        id:
          description: id is a unique scte id assigned by the transcoder per run_id
          format: int32
          minimum: 0
          type: integer
        in_band:
          description: in_band denotes whether the SCTE-35 message was received in the source consumed by the transcoder (In-Band) or signaled via Transcoder API (Out-of-Band).
          type: boolean
        scte35:
          contentEncoding: base64
          type: string
        source:
          enum:
          - SOURCE_UNDEFINED
          - PRIMARY
          - SECONDARY
          type: string
        time:
          description: time is the time at which the SCTE was received by the transcoder.
          format: date-time
          type: string
      type: object
    ListContentSegmentHistoryResponseBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://api.istreamplanet.com/schemas/ListContentSegmentHistoryResponseBody.json
          format: uri
          readOnly: true
          type: string
        content_segments:
          items:
            $ref: '#/components/schemas/TranscoderContentSegment'
          type:
          - array
          - 'null'
      type: object
    TranscoderHeader:
      additionalProperties: false
      properties:
        run_id:
          format: int64
          minimum: 0
          type: integer
      type: object
    GetChannelCostReportResponseBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://api.istreamplanet.com/schemas/GetChannelCostReportResponseBody.json
          format: uri
          readOnly: true
          type: string
        channel_name:
          type: string
        channel_urn:
          type: string
        duration_secs:
          format: int64
          type: integer
        external_id:
          type: string
        has_hdr:
          type: boolean
        has_realtime_output:
          type: boolean
        has_uhd:
          type: boolean
        labels:
          items:
            type: string
          type:
          - array
          - 'null'
        organization:
          type: string
        verbit_encoder_count:
          format: int32
          minimum: 0
          type: integer
      type: object
    ListRawSCTEHistoryByChannelResponseBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://api.istreamplanet.com/schemas/ListRawSCTEHistoryByChannelResponseBody.json
          format: uri
          readOnly: true
          type: string
        raw_scte35:
          items:
            $ref: '#/components/schemas/TranscoderRawSCTE35'
          type:
          - array
          - 'null'
      type: object
    ListRawSCTEHistoryResponseBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://api.istreamplanet.com/schemas/ListRawSCTEHistoryResponseBody.json
          format: uri
          readOnly: true
          type: string
        raw_scte35:
          items:
            $ref: '#/components/schemas/TranscoderRawSCTE35'
          type:
          - array
          - 'null'
      type: object
    TranscoderUPID:
      additionalProperties: false
      properties:
        id:
          contentEncoding: base64
          type: string
        type:
          format: int32
          type: integer
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://api.istreamplanet.com/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          examples:
          - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
          - array
          - 'null'
        instance:
          description: A URI reference that identifies the specific occurrence of the problem.
          examples:
          - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
          - 400
          format: int64
          type: integer
        title:
          description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
          examples:
          - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
          - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    ChannelCostReport:
      additionalProperties: false
      properties:
        channel_name:
          type: string
        channel_urn:
          type: string
        duration_secs:
          format: int64
          type: integer
        external_id:
          type: string
        has_hdr:
          type: boolean
        has_realtime_output:
          type: boolean
        has_uhd:
          type: boolean
        labels:
          items:
            type: string
          type:
          - array
          - 'null'
        organization:
          type: string
        verbit_encoder_count:
          format: int32
          minimum: 0
          type: integer
      type: object
    TranscoderContentSegment:
      additionalProperties: false
      properties:
        end:
          description: end is the timestamp when the content segment ended.
          format: date-time
          type: string
        header:
          $ref: '#/components/schemas/TranscoderHeader'
          description: header is required for all transcoder events.
        segment_id:
          description: segment_id is a unique id assigned by the transcoder
          format: int64
          type: integer
        start:
          description: start is the timestamp when the content segment started.
          format: date-time
          type: string
        type:
          description: 'type is the type of content segment. Example: PROGRAM, CHAPTER, or BREAK.'
          enum:
          - SPLICE_INSERT
          - CONTENT_ID
          - PROGRAM
          - PROGRAM_BLACKOUT_OVERRIDE
          - PROGRAM_BREAKAWAY
          - CHAPTER
          - BREAK
          - OPENING_CREDIT
          - CLOSING_CREDIT
          - PROVIDER_PLACEMENT_OP
          - DISTRIBUTOR_PLACEMENT_OP
          - PROVIDER_OVERLAY_OP
          - DISTRIBUTOR_OVERLAY_OP
          - PROVIDER_AD
          - DISTRIBUTOR_AD
          - UNSCHEDULED_EVENT
          - NETWORK
          - SLATE
          - NOT_INDICATED
          - TIMED_METADATA
          - TIMED_METADATA_MARKER_OVER_SLATE
          type: string
        upids:
          items:
            $ref: '#/components/schemas/TranscoderUPID'
          type:
          - array
          - 'null'
      type: object
  securitySchemes:
    authcode:
      flows:
        authorizationCode:
          authorizationUrl: https://sso.wbd.com/oauth2/aus125bl6q770za4g0x8/v1/authorize
          scopes: null
          tokenUrl: https://sso.wbd.com/oauth2/aus125bl6q770za4g0x8/v1/token
      type: oauth2
    m2m:
      flows:
        clientCredentials:
          scopes: null
          tokenUrl: https://sso.wbd.com/oauth2/aus125bl6q770za4g0x8/v1/token
      type: oauth2
x-refined-from:
- istreamplanet-aventus-channels-openapi.json
- istreamplanet-aventus-channels-openapi.yml
x-cli-config:
  params:
    authorize_url: https://sso.wbd.com/oauth2/aus125bl6q770za4g0x8/v1/authorize
    client_id: 0oa125bj1lwLZRxjD0x8
    redirect_url: http://auth.rest.sh:8484
    scopes: offline_access,Groups
    state: non-empty
    token_url: https://sso.wbd.com/oauth2/aus125bl6q770za4g0x8/v1/token
  security: authcode