Child pages
  • cPanel API 2 Functions - Stats::listlastvisitors

Versions Compared

Key

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

 

Description

Excerpt
This function displays the domains that have that have last visitors information available.
Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Stats&cpanel_jsonapi_func=listlastvisitors

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List domains with last visitor stats available.
$list_last_visitors = $cpanel->api2(
    'Stats', 'listlastvisitors'
    ) 
 );

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.
 
# List domains with analog stats available.
my $list_last_visitors = $cpliveapi->api2(
    'stats', 'listlastvisitors',
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Stats listlastvisitors

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listlastvisitors",
    "data": [
      "domain" : "example.com"
	  "ssl" : "1"
	  "txt"	: "example.com"
 	],
    "event": {
      "result": 1
    },
    "module": "Stats"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

Parameters

This function does not accept parameters.

 

Returns

ReturnTypeDescriptionPossible valuesExample
domainstring

The domain names.

Any valid domains on the server.example.com
sslBooleanWhether the domain uses SSL.
  • 1 — Uses SSL.
  • 0 — Does not use SSL.
1
txtstringThe domains with Analog available.Any valid domains on the server.example.com
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if there was an error.

A string that describes the error. This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1