Child pages
  • cPanel API 1 Functions - Stats::awstats
Skip to end of metadata
Go to start of metadata

Description

This function retrieves the relative URL path to a domain's AWStats data.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_awstatspath = $cpanel->api1('Stats','awstats',array('example.com')); // Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $get_awstatspath = $cpliveapi->api1('Stats','awstats',['example.com'] ); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Stats::awstats($FORM('domain'))">
 Command Line
cpapi1 --user=username Stats awstats example.com


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (plaintext)
/awstats.pl?config=example.com&lang=en

   

Parameters

ParameterTypeDescriptionPossible ValuesExample
domainstring

Required

The domain name.

A valid domain name.example.com

Returns

This function displays the relative path to the domain's AWStats data.