You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

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

Description


This function displays the domain's Analog statistics.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_analoglist = $cpanel->api1('Stats','analoglist',array('example.com','0')); // 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_analistlist = $cpliveapi->api1('Stats','analoglist',['example.com','0'] ); # 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::analoglist($FORM('domain','sopts'))">
 Command Line
cpapi1 --user=username Stats analoglist example.com 0


Notes:

  • Unless otherwise noted, 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.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (plaintext)
The output contains the Analog stats, organized by month.

   

Parameters

ParameterTypeDescriptionPossible ValuesExample
domainstring

Required

The domain name.

A valid domain name.example.com
soptsBoolean

Whether to retrieve statistics for SSL connections.

This value defaults to 0.

  • 1 — Retrieve SSL connection statistics.
  • 0 — Retrieve unsecured connection statistics.
0

Returns

The output contains the Analog statistics, organized by month.