Skip to Content
Cut.ProDocs
Live clipping: monitored channels

Get a broadcast

Returns one broadcast of a live monitor with how its clipping went: clips, ratings and credits charged. While it is on air, next_batch says when the next clips land. 400 INVALID_OBSERVING_TYPE on a video monitor; 404 STREAM_NOT_FOUND when the broadcast is not this channel's.

Authorization

apiKey
headerX-Api-Key<token>

Path Parameters

id*string

Monitor id, from GET /monitors

Match^[0-9]{1,19}$
broadcastId*string

Broadcast id, from GET /monitors/{id}/broadcasts

Response Body

Response for status 200

application/json
  1. response
id*string

The platform's own id for the broadcast

title*string
category*string

Game or category the channel set for the broadcast; empty when none

language*string
is_mature*boolean
tags*array<string>
started_at*string

ISO 8601 timestamp of when the broadcast went on air

ended_at*||

ISO 8601 timestamp of when it went off air; null while it is still live

thumbnail_url*string|null|null
play_url*||

Signed URL to stream our recording, time-limited; null once it was purged

source_url*||

The broadcast's replay on the platform, once it ended and the platform keeps one

recording_expired*boolean

true once the recording was purged: its clips can no longer be listed or rendered

next_batch*||

Progress of the next batch; null unless the broadcast is on air and the monitor is on

clips_count*number

Clips this workspace got from the broadcast

average_rating*||

Average rating of its clips, 0 to 10; null without clips

best_rating*||

Highest rating among its clips; null without clips

clips_duration*number

Sum of the clips' length, in seconds

credits_used*number

Credits charged for this broadcast's batches

batches_count*number

Batches charged for this broadcast

GET
/monitors/{id}/broadcasts/{broadcastId}
Example Request
curl -X GET 'https://api.cut.pro/api/v1/monitors/string/broadcasts/string'
Example Response
{  "id": "string",  "title": "string",  "category": "string",  "language": "string",  "is_mature": true,  "tags": [    "string"  ],  "started_at": "string",  "ended_at": null,  "thumbnail_url": null,  "play_url": null,  "source_url": null,  "recording_expired": true,  "next_batch": null,  "clips_count": 0,  "average_rating": null,  "best_rating": null,  "clips_duration": 0,  "credits_used": 0,  "batches_count": 0}