Description

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

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=lastapachehits&domain=example.com



$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',
    ) 
 );

 



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',
		}
 );




cpapi2 --user=username Stats lastapachehits domain=example.com



{
  "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"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain.

A valid domain on the server.example.com

Returns

ReturnTypeDescriptionPossible valuesExample
protocolstringThe version of the request protocol.Any HTTP request version, in escaped format.
HTTP/1.1
ipstringThe IP address.A valid IP address on the server.
10.4.10.1
statusintegerThe HTTP response code.
  • 200 — OK
  • 400 — Bad request.
  • 404 — File not found.
  • 500 — Internal service error.
  • 503 — Service unavailable.
  • 504 — Gateway timeout.
200
httpupdatestringThe request's date and time.A time stamp, in escaped format.
21/Oct/2014:09:40:29
sizeintegerThe file's size, in bytes.Any positive integer.
400
timestampstringThe request's date and time, in Unix time format.A Unix timestamp.
1413902429
agentstringThe 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) 
urlstringThe requested file's filepath, in escaped format.Any valid filepath.
/otherexample/
methodstringThe HTTP method.
  • GET
  • POST
GET
tzstringThe request's time zone, offset from Greenwich Mean Time (GMT).Any UTC time offshoot-0500
linestringThe HTTP request's RequestLine.Any line in the HTTP request body.2
referrerstringThe URL that directed the client to the log file.Any valid URL on the server.
http://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