WebHostGetStats


Definition

Retrieve the usage statistics for a Web hosting account, for a month you specify in the query string.

Usage

Use this command to retrieve day-by-day usage statistics for a Web hosting account. This command allows monitoring of usage patterns, which is most likely to be useful when a customer inquires about bandwidth overage charges.

To retrieve usage-to-date for the current month, use the GetHostAccount command.

To retrieve bandwidth overages for end-of-month account reconciliation, use the GetHostOverages command.

Availability

All resellers have access to this command.

Implementation on eNom.com

Log on to webhostingtest.ehost–services.com with Login ID resellid, password resellpw.

http://webhostingtest.ehost-services.com/Default.asp?

The Hosting Package Overview shows the results of the WebHostGetStats command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • The Web hosting account must belong to this domain name account.

Input parameters

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword &paramname=paramvalue&nextparamname=nextparamvalue

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
HostAccount Required Web hosting account name 14
Month Required Month for which you want usage statistics. Permitted value is a number in M or MM format. If you specify the current month, the return gives information for each day to date this month. 2
Year Required Year for which you want usage statistics. Permitted value is a number in YYYY format. 4
ResponseType Optional Format of response. Options are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
ReportDate Month
UsedBandWidthMB Web server bandwidth used this month
Hits Number of hits on this domain name
HTMLHits Number of hits on this HTML page
ImageHits Number of hits on images
UniqueIPs Number of unique IPs that hit this Web hosting account
HTMLBandwidthMB Amount of HTML bandwidth used this month
ImageBandwidthMB Amount of bandwidth used to display images this month
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x) Error messages explaining the failure. These can be presented as is back to the client
Done True indicates this entire response has reached you successfully

 

Notes

  • The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
  • Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameterErr(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example