Description

This function retrieves a domain's last visitors.

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 visitors for example.com.
$get_last_visitors = $cpanel->api2(
    'Stats', 'lastapachehits',
		array(
		'domain' 			=> 'example.com',
    ) 
 );



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Retrieve last visitors for example.com.
my $get_last_visitors = $cpliveapi->api2(
    'stats', 'lastvisitors',
		{
			'domain' 			=> 'example.com',
		}
 );




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



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "lastapachehits",
    "data": [
      {
        "ip": "10.4.10.1",
        "version": "HTTP/1.1",
        "path": "/example/",
        "referrer": "http://example.com/",
        "size": "368",
        "timestamp": 1413884431,
        "agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_0),
        "code": "200",
        "line": 5
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Stats"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain.

A valid domain on the server.example.com

Returns

ReturnTypeDescriptionPossible valuesExample
ipstringThe IP address.Any valid IP address.
10.4.10.1
versionstringThe version of the request protocol, in escaped format.Any HTTP request version.
HTTP/1.1
pathstringThe requested file's filepath.Any valid filepath, in escaped format.
/otherexample/
referrerstringThe URL that directed the client to the log file.Any valid URL on the server.
http://example.com/
sizeintegerThe file's size, in bytes.Any positive integer.
400
timestampintegerThe 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) 
codeintegerThe HTTP response code.
  • 200 — OK
  • 400 — Bad request.
  • 404 — File not found.
  • 500 — Internal service error.
  • 503 — Service unavailable
  • 504 — Gateway timeout.
200
linestringThe Request Line of the request.Any line in the HTTP request body.2
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