GET https://api.vidyard.com/dashboard/v1/organizations/:current_organization_id/live/:live_stream_instance_id/health DEPRECATED
Retrieve health stats for a stream instance.

Retrieve health stats for a live stream instance

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found

Examples

REQUEST
GET /api/v1/organizations/15/live/153/health
Content-Type: application/json

RESPONSE
200
{
  "primary":{
    "video_codec_name":"h264",
    "video_width":1920,
    "video_height":1080,
    "video_r_frame_rate":30,
    "video_bit_rate":3072000,
    "audio_codec_name":"aac",
    "audio_sample_rate":48000,
    "audio_bit_rate":147456,
    "created_at":"2021-03-14T11:14:20.000Z"
  },
  "backup":null
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String