ioio.tv APIs

# channel Health Images

API call format

GET /channels/{<workflow_id>}/health

Description

Get a map of all channel health graphs. The key of the map is the name of the graph. This call returns images BASE64 encoded images for all health stats of a channel. We should pass corresponding <workflow_id> mandatory parameter as other optional parameters like image width and height or concrete metric to be returned. A sample BASE64 image decoder can be found here: http://base64image.org/

Precondition

  • Authorization token is needed.
  • Mandatory elements (should be specified):
    • <workflow_id> - valid workflow id. Take a workflow id using Workflow List API call.
    • We have existing workflow channel.

Postcondition

  • On success response code should be 200
  • On success all binary representations of available graphs images will be returned.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/channels/<workflow_id>/health
{
"timezone":"<time_zone>", //optional
"width":"<width>", //optional
"height":"<height>", //optional 
"metrics":"<metric_name>" //optional
}
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"}
[Response]200
[Request Cookies] []
[Response Headers] {"Content-Type":["application/json"],"Connection":["keep-alive"],....} 
[Response] 
{
  "NetworkOut":"<base64_image_representation>",
  "UdpInputLoss":"<base64_image_representation>",
  "DroppedFrames":"<base64_image_representation>",
  "FillMsec":"<base64_image_representation>",
  "NetworkIn":"<base64_image_representation>", 
  "SvqTime":"<base64_image_representation>", 
  "InputVideoFrameRate":"<base64_image_representation>", 
}

← Channel Runnng List →