API Docs

Get to know get_total_bandwidth_usage

Overview: get_total_bandwidth_usage returns an array of total bandwidth usage stats for all devices on a customer's account. Can be limited to on POP with the location parameter.

get_total_bandwidth_usage expects the following parameters:

  • location – The Ubiquity facility to limit the query to.

Example:

$api->call('client.get_total_bandwidth_usage', $params);

Output:

Array
(
    [status] => 1
    [data] => Array
        (
            [in] => Array
                (
                    [min] => 67928
                    [max] => 26396504.9
                    [avg] => 221799.2
                    [cur] => 0
                    [95th] => 678132.2
                    [total] => 16273363707
                )
            [out] => Array
                (
                    [min] => 39.5
                    [max] => 1344270.2
                    [avg] => 2790.8
                    [cur] => 0
                    [95th] => 2196
                    [total] => 650364820
                )
        )
)