API Documentation: usage.data

Synopsis

The Usage Data api retrieves one months worth of account usage and charges. The result is an array of usage types and contains values for usage, rate, cost, estimated usage, and estimated cost.

Example Request (JSON)

Example Code (PHP)

    $request = array(
        'command' => 'usage.data',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        'starttime' => '2017-06-01'   /* optional */
    );
        //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
starttime [OPTIONAL] [string] - Date string containing the year and month to request (ex. 2017-06-01)
[int] - A unix timestamp representation to start the 30 day period.

Example Result (JSON)

    {
        "data":{
            "Storage Usage":{
                "usage":0,
                "rate":"0.00",
                "cost":"0.00",
                "est_usage":0.00,
                "est_cost":"0.00"
                },
            "PHP CPU Hours":{
                "usage":0.00,
                "rate":"0.00",
                "cost":"0.00",
                "est_usage":0.00,
                "est_cost":"0.00"
                },
            "Edge Bandwidth":{},
            "Edge Requests":{},
            "CDN Bandwidth":{},
            "CDN Requests":{},
            "Origin Bandwidth":{},
            "Origin Requests":{},
            "Origin CPU Hours":{},
            "VideoCDN Bandwidth":{},
            "SQL SELECT":{},
            "SQL UPDATE":{},
            "SQL OTHER":{},
            "SQL Replication Bandwidt":{},
            "SQL CPU Hours":{},
            "Total":{
                "subtotal":0.0,
                "estimated":0.0
                }
            },
        "status":"success",
        "message":"Found Usage Summary Data",
        "handle_time":"1.0689 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 - the data array contains arrays of usage. The array keys are the type of usage and their values will contain the usage amount, usage rate, cost of usage, estimated usage, and estimated cost. Only usage types that have data will be present in the response.