cPanel API 2 Functions - Stats::getmonthlybandwidth - Knowledgebase

Description

This function displays a domain's monthly bandwidth statistics.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Stats&cpanel_jsonapi_func=getmonthlybandwidth

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve monthly bandwidth statistics for example.com

$get_monthly_bandwidth = $cpanel->api2(

'Stats', 'getmonthlybandwidth'

)

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve monthly bandwidth statistics for example.com

my $get_monthly_bandwidth = $cpliveapi->api2(

'Stats', 'getmonthlybandwidth',

);

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 ourDeprecated 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

cpapi2 --user=username Stats getmonthlybandwidth

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getmonthlybandwidth",
    "data": [
      {
        "bw": {
          "imap": 3386
        },
        "date": "2014-04"
      },
      {
        "bw": {
          "http": 672
        },
        "date": "2014-10"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Stats"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
bw	hash	A hash of the type and amount of bandwidth data that the account uses.	This hash includes the http, ftp, imap,smtp, and date returns.
http	integer	The amount HTTP bandwidth, in bytes. The function returns this value in the bw hash.	A positive integer.	672
ftp	integer	The amount FTP bandwidth, in bytes. The function returns this value in the bw hash.	A positive integer.	345
imap	integer	The amount IMAP bandwidth, in bytes. The function returns this value in the bw hash.	A positive integer.	3386
smtp	integer	The amount of SMTP bandwidth, in bytes. The function returns this value in the bw hash.	A positive integer.	875
date	string	The month of the bandwidth type's last transfer, in YYYY-MM format. The function returns this value in the bw hash.	A date in YYYY-MM format, where: YYYY represents the four-digit year. MM represents the two-digit date.	2014-04
reason	string	A reason for failure. Note: This function only returns a reasonvalue if there was an error.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories