Child pages
  • UAPI Functions - Stats::list_analog_by_month

Versions Compared

Key

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

Description

Excerpt
This function displays a domain's Analog statistics.


Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Stats/list_analog_by_month?engine=webalizer&traffic=http

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get account statistics for all sites on the cPanel account.
$list_analog_by_month = $cpanel->uapi(
    'Stats', 'list_analog_by_month',
    array(
        'engine'    => 'webalizer',
        'traffic'   => 'http',
  )
);

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.
 
# Get account statistics for all sites on the cPanel account.
my $list_analog_by_month = $cpliveapi->uapi(
    'Stats', 'list_analog_by_month',
    {
        'engine'   => 'webalizer',
        'traffic'  => 'http',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink
 


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username Stats list_analog_by_month engine=webalizer traffic=http

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
      
  },
  "data": [
	{
    	"path" : "/tmp/user/webalizer/index.html",
    	"ssl" : 1,
    	"domain" : "example.com"
		"all_domains" : "1"
	}
]	


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
enginestring

Required

The statistics engine.

  • webalizer 
  • analog 
webalizer
trafficinteger

The web traffic type.

This parameter defaults to http.

  • http 
  • ftp 
http

Returns

ReturnTypeDescriptionPossible valuesExample
pathstring

The filepath to the statistics file.

A valid filepath.

/tmp/user/webalizer/index.html
urlstringThe domain for which to display statistics.A domain on the cPanel account.example.com