Description

This function displays domains that have Webalizer statistics available.


  • You must authenticate as the cPanel user that you specify in the account parameter to call this function.
  • We  strongly  recommend that you use  UAPI  instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples




https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Stats&cpanel_jsonapi_func=listwebalizer



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List domains on the server that have webalizer statistics available.
$list_available_webalizer = $cpanel->api2(
    'Stats', 'listwebalizer'
    ) 
 );

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List domains on the server that have webalizer statistics available.
my $list_available_webalizer = $cpliveapi->api2(
    'Stats', 'listwebalizer',
 );




cpapi2 --user=username Stats listwebalizer



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listwebalizer",
    "data": [
      "domain" : "example.com"
	  "user" : "user"
	  "dir" : "/stats"
	  "txt"	: "example.com"
 	],
    "event": {
      "result": 1
    },
    "module": "Stats"
  }
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
domainstring

The domain names.

Any valid domains on the server.example.com
userstringThe authenticated user.Any valid username.

user

dirintegerThe directory that contains the Webalizer data.Any valid directory name on the server./stats
textstringThe domains with Webalizer stats available.Any valid domains on the server.example.com
reasonstring

A reason for failure.

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