Description

This function displays domains that have AWStats web statistics available.

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=listawstats



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List domains on the server that use AWStats.
$list_available_awstats = $cpanel->api2(
    'Stats', 'listawstats'
    ) 
 );

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List domains on the server that use AWStats available.
my $list_available_awstats = $cpliveapi->api2(
    'Stats', 'listawstats',
 );




cpapi2 --user=username Stats listawstats



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listawstats",
    "data": [
      "domain" : "example.com"
	  "lang" : "English"
	  "ssl" : "1"
	  "txt"	: "example.com"
 	],
    "event": {
      "result": 1
    },
    "module": "Stats"
  }
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
domainstring

The domain name(s).

Any valid domain(s) on the server.example.com
langstringThe language that AWStats uses.Any language.

English

sslBooleanWhether the domain(s) use(s) SSL.
  • 1 — Uses SSL.
  • 0 — Does not use SSL.
1
txtstringThe domain(s) with AWStats 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