Corinne.chui: 1 revision

2016-05-30T19:35:03Z

1 revision

Jerry.dimitrov: /* URI Parameters */

2015-10-07T13:47:39Z

URI Parameters

Mike.robski: 1 revision: Release 111

2015-09-18T17:15:15Z

1 revision: Release 111

Jerry.dimitrov: Created page with "= GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic = Get traffic statistics by specific time range for an IP address of a dedic..."

2015-09-15T14:53:49Z

Created page with "= GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic = Get traffic statistics by specific time range for an IP address of a dedic..."

New page

= GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic =
Get traffic statistics by specific time range for an IP address of a dedicated server.
__TOC__

=== Request ===
<code>GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope={scope}&startDate={startDate}&endDate={endDate}&period={period}''&''method={method}</code>

== URI Parameters ==
; accountId - ''string''
: ''(required)''
: The account Id of the dedicated server owner.

; serverId
: ''(required)''
: The dedicated server Id for the requested IP address.

; ipAddress - ''string''
: The specific IP address.

; scope
: ''(required)''
: The scope defines whether we want statistics for inbound or outbound traffic. Possible values: '''receive''' and '''transmit'''.

; startDate
: ''(required)''
: Start date that represents the beginning of the requested statistical time frame. The format should be '''yyyy-mm-dd'''.

; endDate
: ''(required)''
: End date that represents the end of the requested statistical time frame. The format should be '''yyyy-mm-dd'''.

; period
: ''(required)''
: Represents the granularity of the returned data sets for the requested time frame. Possible values: '''hourly''' or '''daily'''.

; method
: ''(required)''
: Statistics method used. Possible values: '''avg''','''sum''','''min''' and '''max'''.

=== Request Headers ===

;: {{Authorization}}
; Accept - HTTP Accept header [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1]
: Possible values are ''application/json'', ''text/csv''. If omitted json will be returned.

== Date Format ==
: All dates are interpreted and represented in UTC with [http://www.iso.org/iso/home/standards/iso8601.htm ISO 8601 format]

== Response ==
=== Status Codes ===
; 200 OK
: Success

; 400 Bad Request
: Incorrect URI parameters.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 403 Forbidden
: The authorized user does not have permissions to access the resource or the requested time frame exceeds the maximum limit for the API.
: The current limit is 500 data sets per response entity, regardless of the period granularity.

; 404 Not Found
: The dedicated server or account does not exist.

=== Response Body ===
<nowiki>
[
{
"count": {count},
"date": "{date}",
"values": {values}
}
]</nowiki>

==== Parameters ====
; count - ''integer''
: The count of traffic operations for the specified period.

; date - ''string''
: The date time stamp for the specified period.

; values - ''float''
: The actual traffic value represented for the specified period.

== Examples ==
'''Successful response for total daily inbound traffic statistics'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope=receive&startDate=2015-05-05&endDate=2012-05-07&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
[
{
"count": 143,
"date": "2015-05-05 00:00:00",
"values": 344130.30069930002
},
{
"count": 144,
"date": "2015-05-07 00:00:00",
"values": 658.34027777777999
},
]</nowiki>

'''Failure while trying to get traffic statistics and the number of returned data sets exceeds the maximum limit'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope=receive&startDate=2015-01-01&endDate=2015-05-05&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
<nowiki>
{
"overLimit": {
"message": "GET data error",
"code": 403,
"details": "The (startDate, endDate) range is too large. Maximum number of returned data sets exceeded."
}
}</nowiki>

'''Failure while trying to get traffic statistics and the start date is before the create date (2015-01-01) of the dedicated server'''
:'''GET''' /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic?scope=receive&startDate=2011-01-01&endDate=2015-05-05&period=daily&method=sum

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
<nowiki>
{
"badRequest": {
"message": "GET data error",
"code": 400,
"details": {
"startDate": "2011-01-01 is less than minimum value 2015-01-01"
}
}
}</nowiki>

[[Category:Hostway API]]
[[Category:Dedicated Server API]]

@@ Line 20: / Line 20: @@
 ; scope
 : ''(required)''
-: The scope defines whether we want statistics for inbound or outbound traffic. Possible values: '''receive''' and '''transmit'''.
+: The scope defines whether we want statistics for inbound or outbound traffic. Possible values: '''receive''' and '''transmit''' and '''total''' (receive plus transmit values).
 ; startDate

Accounts-accountId-dedicatedServers-serverId-ipAddresses-ipaddress-statistics-traffic:GET - Revision history

Corinne.chui: 1 revision

Jerry.dimitrov: /* URI Parameters */

Mike.robski: 1 revision: Release 111

Jerry.dimitrov: Created page with "= GET /accounts/{accountId}/dedicatedServers/{serverId}/ipAddresses/{ipAddress}/statistics/traffic = Get traffic statistics by specific time range for an IP address of a dedic..."