Child pages
  • cPanel API 2 Functions - Stats::getmonthlybandwidth

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt
This function displays a domain's monthly bandwidth statistics.
Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Retrieve monthly bandwidth statistics for example.com
$get_monthly_bandwidth = $cpanel->api2(
    'Stats', 'getmonthlybandwidth'
    ) 
 );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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',

 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Stats getmonthlybandwidth

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getmonthlybandwidth",
    "data": [
      {
        "bw": {
          "imap": 3386
        },
        "date": "2014-04"
      },
      {
        "bw": {
          "http": 672
        },
        "date": "2014-10"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Stats"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

Parameters

This function does not accept parameters.

 

Returns

ReturnTypeDescriptionPossible valuesExample
bwhash

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
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if there was an error.

A string that describes the error. This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1