cPanel API 2 Functions - StatsBar::stat - Knowledgebase

Description

This function retrieves an account's statistics.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

StatsBar::get_stats — This function retrieves a cPanel account's statistics.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=StatsBar&cpanel_jsonapi_func=stat&display=ftpaccounts%7Cperlversion%7Cdedicatedip&warnings=0&warninglevel=high&warnout=0&infinityimg=/home/example/infinity.png&infinitylang=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
//  Display stats bar data for ftpaccounts|perlversion|dedicatedip
$stats_bar = $cpanel->api2(
    'StatsBar', 'stat',
    array(
        'display'      => 'ftpaccounts|perlversion|dedicatedip',
        'warnings'      => '0',
        'warninglevel   => 'high'
        'warnout'       => '0'
        'infinityimg'   => '/home/example/infinity.png'
        'infinitylang'  => 'infinity'
        'rowcounter'    => 'even'
 )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Display stats bar data for ftpaccounts|perlversion|dedicatedip
my $stats_bar = $cpliveapi->api2(
    'StatsBar', 'stat',
    {
        'display'      => 'ftpaccounts|perlversion|dedicatedip',
        'warnings'      => '0',
        'warninglevel   => 'high'
        'warnout'       => '0'
        'infinityimg'   => '/home/example/infinity.png'
        'infinitylang'  => 'infinity'
        'rowcounter'    => 'even'
 }
);

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 StatsBar stat display=ftpaccounts\|perlversion\|dedicatedip warnings=0 warninglevel=high warnout=0 infinityimg=\/home\/example\/infinity.png infinitylang=infinity rowcounter=even

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "stat",
    "data": [
      {
        "zeroisunlimited": 0,
        "percent": 0,
        "percent10": 0,
        "max": "unlimited",
        "item": "FTP Accounts",
        "feature": "ftpaccts",
        "percent5": 0,
        "id": "ftpaccounts",
        "phrase": "FTP Accounts",
        "module": "API::Ftp",
        "count": "3",
        "_count": "3",
        "name": "ftpaccounts",
        "_max": "unlimited",
        "percent20": 0,
        "_maxed": 0
      },
      {
        "count": null,
        "value": "5.10.1",
        "percent": 0,
        "percent10": 0,
        "max": "",
        "item": "Perl Version",
        "name": "perlversion",
        "percent20": 0,
        "percent5": 0,
        "_maxed": 0,
        "id": "perlversion",
        "phrase": "Perl Version",
        "module": "Serverinfo"
      },
      {
        "count": null,
        "value": "10.215.214.95",
        "percent": 0,
        "percent10": 0,
        "max": "",
        "item": "Dedicated IP Address",
        "name": "dedicatedip",
        "percent20": 0,
        "percent5": 0,
        "_maxed": 0,
        "id": "dedicatedip",
        "phrase": "Dedicated IP Address",
        "condition": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "StatsBar"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
display	string	Required A list of the account's statistics.	Click to view... Note: Separate each value with a pipe character (\|).	ftpaccounts\|perlversion\|dedicatedip
warnings	Boolean	Required Whether to return all results.	1 — Return only warnings that exceed the warninglevelparameter's value. 0 — Return all results.	0
warninglevel	integer	Required The minimum level at which to return warnings.	A positive integer.	87
warnout	Boolean	Required Whether to display results with a value of 100%.	1 — Display results with a value of 100% 0 — Hide results with a value of 100%	0
infinityimg	string	Required The full file path to an alternative infinity symbol.	An absolute file path to an image file.	/home/example/infinity.png
infinitylang	string	Required A phrase represent infinity that the locales system can use.	A string value.	infinity
rowcounter	string	Required The type of row.	odd even	even

Returns

Return	Type	Description	Possible vales	Example
zeroisunlimited	Boolean	Whether a value of 0 means unlimited or zero.	1 — Unlimited. 0 — Zero.	1
percent10	integer	The percentage of value.	A positive integer. Note: Round to the nearest ten if applicable.	0
percent	integer	The percentage of value, if applicable.	An integer value.	0
item	string	A human-readable version of the queried item.	A string value.	Disk Space Usage
max	string	The queried value's limit.	A string value.	unlimited
langkey	string	The value's display locale.	A string value.	INDXDiskUsage
percent5	integer	The percentage of value.	An integer value. Note: Round to the nearest five if applicable.	0
id	string	The display key.	A string value.	diskusage
module	string	The module that retrieved the information.	A string value.	Quota
count	string	The queried data's value.	A string value.	0.77
_count	string	The queried data's value.	A string value.	0.77
name	string	The display key.	A string value.	diskusage
_max	string	The queried parameter's limit.	A string value.	unlimited
normalized	Boolean	Whether the function normalized the output values.	1 — Normalized. 0 — Did not normalize.	1
_percent20	integer	The percentage of value.	An integer value. Note: Round to the nearest twenty if applicable.	0
_maxed	Boolean	Whether the values reached their maximum value.	1 — Reached maximum value. 0 — Has not reached maximum value.	0
units	string	The queried value's unit of measure.	A string value.	MB

Knowledgebase

Categories

Categories