cPanel API 2 Functions - Bandwidth::gethourlyaveragebwoveryear

Description

This function returns an account's average hourly peak bandwidth use for one year.

Warning:

We removed this function in cPanel & WHM version 11.52. We strongly recommend that you use the following UAPI function instead of this function:

  • Bandwidth::query — This function queries an account's bandwidth data and returns a report.

Examples 

 WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Bandwidth&cpanel_jsonapi_func=gethourlyaveragebwoveryear&types=all&cf=AVERAGE

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Get bandwidth data for example.com.
$add_bandwidth = $cpanel->api2(
    'bandwidth', 'gethourlyaveragebwoveryear',
        array(
        'types'             => 'all',
        'cf'                => 'AVERAGE',
    )
  );

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Get bandwidth data for example.com.
my $get_bandwidth_data = $cpliveapi->api2(
    'Bandwidth', 'gethourlyaveragebwoveryear',
    {
        'types'             => 'all',
        'cf'                => 'AVERAGE',
    }  
);

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.


 Command Line

Important:

Because we removed this function before we introduced this functionality, you cannot call this function via the command line. 


 Output (JSON)

 

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "gethourlyaveragebwoveryear",
    "data": [
      {
        "ftp": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "smtp": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "http": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "pop3": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "imap": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
  • 0 Users Found This Useful
    • Was this answer helpful?

    Related Articles

    The cPanel Interface

    For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

    User Preferences

    For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

    Manage External Authentications

    For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

    What is cPanelID?

    In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

    Guide to cPanel Interface Customization - cPanel Style Development

    Introduction You can develop custom styles that modify the appearance of the cPanel interface....

      Support

      My Support Tickets   Announcements   Knowledgebase   Downloads   System Status   Open Ticket