Control Panel — API Documentation

Welcome to the new Control Panel. If you are having trouble with any functionality, or have any feedback, we would appreciate a support ticket. Additionally, you can continue to use the old control panel until it is retired in March 2019.

video.servers

Retrieves 30 days worth of video usage per server and day.

Example Request (JSON)


	

Example Code (PHP)

    $request = array(
        'command' => '',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        'app' => 'jb-origin',
        'starttime' => '2019-01-20',
        
            app
            [REQUIRED]
            
  • [int] - The ScaleEngine Application ID to return usage data for. See video.getapps to retrieve a list of your ScaleEngine Application names and IDs
  • [array int] - An array of ScaleEngine Application ID to return usage data for
  • [string] - The ScaleEngine Application name to return usage data for
  • [array string] - An array of ScaleEngine Application names to return usage data for. See video.getapps to retrieve a list of your ScaleEngine Application names and IDs
starttime [OPTIONAL] [string] - Date string containing the year and month to request (ex. 2019-01-01)
[int] - A unix timestamp representation to start the 30 day period. ); //Create request signature $json_request = json_encode($request); $sig = base64_encode(hash_hmac('sha256', $json_request, '8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f', true)); $request['signature'] = $sig; $json_request = json_encode($request); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://api.scaleengine.net/stable/'); // Set the URL curl_setopt($ch, CURLOPT_POST, true); // Perform a POST curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // If not set, curl prints output to the browser curl_setopt($ch, CURLOPT_HEADER, false); // If set, curl returns headers as part of the data stream curl_setopt($ch, CURLOPT_POSTFIELDS, array('json' => $json_request)); //'Json' string or 'PHP' serialized return //If your PHP host does not have a proper SSL certificate bundle, you will need to turn off SSL Certificate Verification //This is dangerous, and should only be done temporarily until a proper certificate bundle can be installed //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate. //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate. $response = curl_exec($ch); //Execute the API Call if (!$response) { die('Failed to connect to ScaleEngine API'); } //Decode the response as an associative array $arrResponse = json_decode($response, true); if ($arrResponse) { //Operation completed successfully //TODO Add work here print_r($arrResponse); } else { //Operation failed echo 'An error occured processing your request:'; print_r($response); }

Request Fields

command [REQUIRED] [string] - API command to execute
cdn_id [REQUIRED] [int] - The ScaleEngine CDN ID of your account
api_key [REQUIRED] [string] - The API key provided as part of your account
timestamp [REQUIRED] [int] - The unix timestamp of your request, used to prevent authenticated API requests from being replayed

Example Result (JSON)

    {
    "data": [{
        "date": "2019-01-20",
        "server": "HML",
        "bytes_total": 0,
        "requests_total": 0,
    },],
    "message": "Found Video Region Data",
    "status": "success",
    "handle_time":"0.3795 seconds"
    }
	

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
handle_time [float] - The amount of time spent processing your request
data [array] - Array of usage data containing the date, server, bytes usage, and total requests