Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]Modules and Plugins [+] Modules and Plugins [-]
cPanel Modules
Writing cPanel Modules PHP Accounting Module cPanel::Accounting Perl Module Writing cPanel Plugins
Writing cPanel Plugins PHP in cPanel Plugin Interfaces cPanel CGI Scripts Live PHP in cPanel Plugins Plugin Variables Installing cPanel Plugins Adding Icons and Groups Plugin Installation File Generator Plugin Security Policy (
.pdf)
WHM Plugins
Creating WHM Plugins ACL Reference Table The swapip Utility cPanel Logger Module Pluggable dnsadmin Modules EasyApache Modules
Custom Modules?
cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]
Standardized Hooks Introduction Taxonomy Getting Started Hooks Management Interface Hookable Events Advanced Usage Troubleshooting
Legacy Hooks Introduction Writing Function Hooks Script Hooks Custom Event Handlers cPanel Logger Module Universal Password Trap Hooking into EasyApache
EasyApache Hooks?
cPAddons (Site Software) [+] cPAddons (Site Software) [-]
System Administration [+] System Administration [-]
Developer Software [+] Developer Software [-]
Back to All Documentation
Stats Module Documentation
Allows a user to view statistics information The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.Stats::listwebalizer
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Display domains that have webalizer statistics available. This data can be used to create a link to webalizer using the following url ":2083/tmp/$user/webalizer/$dir/index.html" |
| Returns: | |
<data> <domain> The domain with awstats available.</domain> <user> The currently authenticated cPanel user.</user> <dir> The directory containing the webalizer data, this will usually be the same as the domain name.</dir> <txt> The domain with awstats available.</txt> </data> |
Stats::listawstats
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Display domains that have awstats web statistics available. This data can be used to create a link to awstats using the following url ":2083/awstats.pl?config=$domain&ssl=$ssl&lang=$lang" |
| Returns: | |
<data> <domain> The domain with awstats available.</domain> <lang> The language that awstats is configured to use.</lang> <ssl> Boolean value indicating whether the awstats domain listing is for SSL or not.</ssl> <txt> The domain with awstats available.</txt> </data> |
Stats::listlastvisitors
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Display domains that have last visitors information available. This data can be used to create to a link the last visitors page using the following url ":2083/frontend/x3/stats/lastvisit.html?domain=$domain&ssl=$ssl" |
| Returns: | |
<data> <domain> The domain with analog available.</domain> <ssl> boolean integer indicating that the statistics are for an SSL Host.</ssl> <txt> The domain with analog available.</txt> </data> |
Stats::listurchin
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Display domains that have urchin web statistics available |
| Returns: | |
<data> <domain> The domain with urchin statistics available.</domain> <txt> The domain with urchin statistics available.</txt> </data> |
Stats::listrawlogs
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Display domains that have raw log downloads available and the URL to download the raw logs from. |
| Returns: | |
<data> <domain> The domain with analog available.</domain> <link> The URL to access the raw logs.</link> </data> |
Stats::listanalog
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Display domains that have analog statistics available. This data can be used to create a link to analog using the following url ":2083/frontend/x3/stats/analog.html?domain=$domain&ssl=$ssl" |
| Returns: | |
<data> <domain> The domain with analog available.</domain> <ssl> boolean integer indicating that the statistics are for an SSL Host.</ssl> <txt> The domain with analog available.</txt> </data> |
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 27 Mar 2012 - 16:46:07 - Main.JenniferDoubrava