{
  "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "name": "test_stream",
  "creatorId": "object",
  "lastSeen": 1587667174725,
  "sourceSegments": 1,
  "transcodedSegments": 2,
  "sourceSegmentsDuration": 1,
  "transcodedSegmentsDuration": 2,
  "sourceBytes": 1,
  "transcodedBytes": 2,
  "ingestRate": 1,
  "outgoingRate": 2,
  "isActive": "boolean",
  "isHealthy": true,
  "issues": ["Buffer underflow", "Network congestion"],
  "createdByTokenName": "staging key",
  "createdAt": 1587667174725,
  "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "streamKey": "hgebdhhigq",
  "playbackId": "eaw4nk06ts2d0mzb",
  "playbackPolicy": {
    "type": "public",
    "webhookId": "3e02c844-d364-4d48-b401-24b2773b5d6c",
    "webhookContext": {
      "foo": "bar"
    }
  },
  "profiles": [
    {
      "name": "720p",
      "width": 1280,
      "height": 720,
      "bitrate": 3000,
      "fps": 30
    }
  ],
  "record": "boolean",
  "multistream": {
    "targets": [
      {
        "id": "PUSH123",
        "profile": "720p"
      }
    ]
  },
  "suspended": "boolean"
}

​
Stream Object

​
id
string
Unique identifier for the stream.
​
name
string
Name of the stream.
​
creatorId
string
Reference to the creator-id schema.
​
lastSeen
number
Timestamp of the last activity on the stream.
​
sourceSegments
number
Number of source segments.
​
transcodedSegments
number
Number of transcoded segments.
​
sourceSegmentsDuration
number
Duration of all the source segments in seconds.
​
transcodedSegmentsDuration
number
Duration of all the transcoded segments in seconds.
​
sourceBytes
number
Total bytes of source segments.
​
transcodedBytes
number
Total bytes of transcoded segments.
​
ingestRate
number
Rate at which sourceBytes increases (bytes/second).
​
outgoingRate
number
Rate at which transcodedBytes increases (bytes/second).
​
isActive
boolean
Indicates if the stream is currently active.
​
isHealthy
object
Reference to the stream-health-payload schema for health status.
​
issues
object
Reference to the stream-health-payload schema for human-readable issues.
​
createdByTokenName
string
Name of the token used to create this stream.
​
createdAt
number
Timestamp (in milliseconds) of when the stream object was created.
​
parentId
string
Identifier for the parent stream object.
​
streamKey
string
Key used to form the RTMP ingest URL.
​
playbackId
string
Identifier used to form the playback URL.
​
playbackPolicy
object
Reference to the playback-policy schema.
​
profiles
array
Array of profiles detailing various streaming qualities.
​
record
boolean
Indicates if the stream should be recorded.
​
multistream
object
Details about multistreaming targets and their configurations.
​
suspended
boolean
Indicates if the stream is currently suspended.
{
  "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "name": "test_stream",
  "creatorId": "object",
  "lastSeen": 1587667174725,
  "sourceSegments": 1,
  "transcodedSegments": 2,
  "sourceSegmentsDuration": 1,
  "transcodedSegmentsDuration": 2,
  "sourceBytes": 1,
  "transcodedBytes": 2,
  "ingestRate": 1,
  "outgoingRate": 2,
  "isActive": "boolean",
  "isHealthy": true,
  "issues": ["Buffer underflow", "Network congestion"],
  "createdByTokenName": "staging key",
  "createdAt": 1587667174725,
  "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "streamKey": "hgebdhhigq",
  "playbackId": "eaw4nk06ts2d0mzb",
  "playbackPolicy": {
    "type": "public",
    "webhookId": "3e02c844-d364-4d48-b401-24b2773b5d6c",
    "webhookContext": {
      "foo": "bar"
    }
  },
  "profiles": [
    {
      "name": "720p",
      "width": 1280,
      "height": 720,
      "bitrate": 3000,
      "fps": 30
    }
  ],
  "record": "boolean",
  "multistream": {
    "targets": [
      {
        "id": "PUSH123",
        "profile": "720p"
      }
    ]
  },
  "suspended": "boolean"
}