cPanel API 2 Functions - Stats::lastapachehits

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function retrieves the Apache log file's most recent hits to a domain.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:

In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.


Examples


WHM API (JSON)

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

For more information, read our Calls from the WHM API documentation.


LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve last Apache hits for example.com.
$get_last_apache_hit = $cpanel->api2(
    'Stats', 'lastapachehits',
        array(
        'domain'            => 'example.com',
    )
 );
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.

# Retrieve last Apache hits for example.com.
my $get_last_apache_hit = $cpliveapi->api2(
    'stats', 'lastapachehits',
        {
            'domain'            => 'example.com',
        }
 );
Note:

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


cPanel Tag System (deprecated)

Warnings:
  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username Stats lastapachehits domain=example.com
Notes:
  • You must URI-encode values.
  • username represents your account-level username.
  • You must include the --user=username option.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:
    /usr/local/cpanel/bin/cpapi2

Output (JSON)

{
    "cpanelresult": {
        "apiversion": 2,
        "func": "lastapachehits",
        "data": [{
            "protocol": "HTTP/1.1",
            "ip": "10.4.10.1",
            "status": "404",
            "httpdate": "21/Oct/2014:09:40:27",
            "size": 0,
            "timestamp": 1413902427,
            "agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_0)",
            "url": "/otherexample/",
            "method": "GET",
            "tz": "-0500",
            "line": 1,
            "referer": ""
        }],
        "event": {
            "result": 1
        },
        "module": "Stats"
    }
}
Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.


Parameters

Parameter Type Description Possible values Example
domain string

Required

The domain.

A valid domain on the server. example.com

Returns

Return Type Description Possible values Example
protocol string The version of the request protocol. Any HTTP request version, in escaped format.
HTTP/1.1
ip string The IP address. A valid IP address on the server. 10.4.10.1
status integer The HTTP response code.
  • 200 — OK
  • 400 — Bad request.
  • 404 — File not found.
  • 500 — Internal service error.
  • 503 — Service unavailable.
  • 504 — Gateway timeout.
200
httpupdate string The request's date and time. A time stamp, in escaped format. 21/Oct/2014:09:40:29
size integer The file's size, in bytes. Any positive integer. 400
timestamp string The request's date and time, in Unix time format. A Unix timestamp. 1413902429
agent string The agent of the client that requested the file. Any web client and operating system.
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_0) 
url string The requested file's filepath, in escaped format. Any valid filepath. /otherexample/
method string The HTTP method.
  • GET
  • POST
GET
tz string The request's time zone, offset from Greenwich Mean Time (GMT). Any UTC time offshoot -0500
line string The HTTP request's RequestLine. Any line in the HTTP request body. 2
referrer string The URL that directed the client to the log file. Any valid URL on the server. http://example.com/
reason string

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.
result Boolean

Whether the function succeeded.

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