Documentation Home> DeveloperResources/ApiRefEditAttach

statsbar::stat(hash)

API Version: 2
Description: Return a hash containing various statistics about an account including software versions, program paths and resource usage.
Parameters
display => string, see notes
This takes a | seperated list of values. The possible values are as follows:
ftpaccounts
perlversion
dedicatedip
hostname

operatingsystem
sendmailpath
autoresponders
perlpath
emailforwarders
bandwidthusage
emailfilters
mailinglists
diskusage

phpversion
sqldatabases
apacheversion
kernelversion
shorthostname
parkeddomains
cpanelbuild
theme
addondomains

cpanelrevision
machinetype
cpanelversion
mysqldiskusage
mysqlversion
subdomains
postgresdiskusage
sharedip
hostingpackage

emailaccounts
Returns
$VAR1  =  {  
                    'diskusage'  =>  {  
                                                  'zeroisunlimited'  =>  '1',  
                                                  'percent10'  =>  '0',  
                                                  'percent'  =>  '0',  
                                                  'item'  =>  'Disk  Space  Usage',  
                                                  'max'  =>  '1000  MB',  
                                                  'langkey'  =>  'INDXDiskUsage',  
                                                  'percent5'  =>  '0',  
                                                  'rowtype'  =>  'even',  
                                                  'id'  =>  'diskusage',  
                                                  'module'  =>  'Quota',  
                                                  'count'  =>  '3.11',  
                                                  '_count'  =>  '3.11',  
                                                  '_max'  =>  '1000',  
                                                  'normalized'  =>  '1',  
                                                  'percent20'  =>  '0',  
                                                  '_maxed'  =>  '0',  
                                                  'units'  =>  'MB'  
                                              },  
                    'bandwidthusage'  =>  {  
                                                            'zeroisunlimited'  =>  '1',  
                                                            'percent10'  =>  '0',  
                                                            'percent'  =>  '0',  
                                                            'item'  =>  'Monthly  Bandwidth  Transfer',  
                                                            'max'  =>  '∞  MB',  
                                                            'feature'  =>  'bandwidth',  
                                                            'langkey'  =>  'INDXBandwidth',  
                                                            'percent5'  =>  '0',  
                                                            'rowtype'  =>  'odd',  
                                                            'id'  =>  'bandwidthusage',  
                                                            'module'  =>  'Stats',  
                                                            'count'  =>  '0',  
                                                            '_count'  =>  '0',  
                                                            '_max'  =>  'unlimited',  
                                                            'normalized'  =>  '1',  
                                                            'percent20'  =>  '0',  
                                                            '_maxed'  =>  '1',  
                                                            'units'  =>  'MB'  
                                                        }  
                };  

Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r2 - 03 Sep 2009 - 19:06:59 - Main.JustinSchaefer
DeveloperResources/ApiRef.StatsBarRef moved from Sandbox/ApiRef.StatsBarRef on 03 Sep 2009 - 19:06 by Main.JustinSchaefer - put it back
 

Copyright © cPanel 2000-2010.