This function retrieves a cPanel account's statistics. |
Examples
|
Parameter | Type | Description | Possible values | Example | ||
---|---|---|---|---|---|---|
display | string | Required A list of the account's statistics. |
| bandwidthusage|diskusage | ||
warnings | Boolean | Whether to return all results with a warning. This value defaults to |
| 0 | ||
warninglevel | integer | The minimum level at which to return warnings. This value defaults to | A positive integer. | 87 | ||
warnout | Boolean | Whether to display results with a value of This value defaults to |
| 0 | ||
| string | The full filepath to an alternative infinity symbol. This value defaults to | A valid image's filepath. | /home/example/infinity.png | ||
infinitylang | string | A phrase to represent infinity that the locales system can use. This value defaults to | A string value. | infinity | ||
rowcounter | string | The type of row. This value defaults to |
| even |
Return | Type | Description | Possible vales | Example | |
---|---|---|---|---|---|
data | array of hashes | This array of hashes contains results from the account's query. | This array of hashes contains the _count , _max , _maxed , count , condition , id , is_maxed , item , langkey , max , maxed_phrase , module , name , near_limit_phrase , normalized , percent , percent5 , percent10 , percent20 , role , rowtype , units , and zeroisunlimited returns. | ||
| string | The queried data's value. This function returns this value in the | A string value. | 1.75 | |
| string | The queried parameter's limit. This function returns this value in the | A string value. | 1024.00 | |
| Boolean | Whether the queried value reached its maximum value. This function returns this value in the |
| 0 | |
| string | The queried data's value. This function returns this value in the | A string value. | 1.75 MB | |
| Boolean | Whether the queried data's value possesses a conditional requirement. This function returns this value in the |
| 1 | |
| string | The queried item's reference name. This function returns this value in the | A string value. | diskusage | |
| integer | Whether the queried value has reached its maximum value. This function returns this value in the | An integer value. | 0 | |
| string | A human-readable version of the queried item. This function returns this value in the | A string value. | Disk Space Usage | |
| string | The queried value's display locale. This function returns this value in the | A string value. | INDXDiskUsage | |
| string | The queried value's limit. This function returns this value in the | A string value. | 1 GB | |
| string | The
This function returns this value in the | A string value with Template Toolkit tags. |
| |
| string | The module that retrieved the information. This function returns this value in the | A string value. | Quota | |
| string | The display key. This function returns this value in the | A string value. | diskusage | |
| string | The
This function returns this value in the | A string value with Template Toolkit tags. |
| |
| Boolean | Whether the function normalized the output values. This function returns this value in the |
| 1 | |
| integer | The percentage of value, if applicable. This function returns this value in the | An integer value. | 0 | |
| integer | The percentage of value. This function returns this value in the | An integer value that the system rounds to the nearest five, if applicable. | 0 | |
| integer | The percentage of value. This function returns this value in the | A positive integer that the system rounds to the nearest ten, if applicable. | 0 | |
| integer | The percentage of value. This function returns this value in the | A positive integer that the system rounds to the nearest twenty, if applicable. | 0 | |
| string | The queried value's role.
This function returns this value in the |
| DNS | |
| string | The queried value's row type. This function returns this value in the |
| odd | |
| string | The queried value's unit of measure. This function returns this value in the | A string value. | MB | |
| Boolean | Whether a value of This function returns this value in the |
| 1 |
Function information
About this moduleThe About UAPIFind a function Related functions |