Get Traffic Usage

Indicates traffic usage statistics for a particular platform and billing region. The type of billing information returned by this endpoint, which can either be data transferred or bandwidth usage, is determined by the Units request parameter. Please choose the billing endpoint that corresponds to the one specified in your contract.

For the purposes of billing, report data is closed on the 3^rd of the month. This means that report data for the current month is incomplete until after the third of the next month.

Bandwidth Usage

Bandwidth usage information for the specified platform and billing region over the specified month can be viewed by setting the Units request parameter to 1. This setting will cause this endpoint to report the amount of data (Megabits) transferred per second during peak usage. This information is useful for viewing whether 95% usage of the bandwidth specified in your contract has been exceeded.

Data Transferred

The total amount of data transferred (GB) for the specified platform and billing region over the specified month can be viewed by setting the Units request variable to 2.

Request

A request to retrieve billing statistics is described below.

HTTP Method	Request URI
GET	https://api.edgecast.com/v2/reporting/customers/AccountNumber/media/Platform/region/Region/units/Units/trafficusage?begindate=BillingMonth

Define the following variables when submitting the above request.

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
AccountNumber Required	Replace this variable with a customer account number. This account number may be found in the upper right-hand corner of the MCC.
Platform Required	Replace this variable with an integer that indicates the platform for which a report will be generated. Valid values are: 3: HTTP Large 7: HTTP Large (SSL Traffic Only) 8: HTTP Small 9: HTTP Small (SSL Traffic Only) 14: Application Delivery Network (ADN) 15: Application Delivery Network (ADN) - (SSL Traffic Only)
Region Required	Replace this variable with the ID of the desired billing region. Use the Get Billing Regions endpoint to retrieve a list of billing regions and IDs.
Units Required	Replace this variable with an integer that determines whether the UsageResult response parameter will return bandwidth usage or data transferred statistics. Valid values are: 1: Megabits per second (Mbps) – Bandwidth Usage 2: Gigabytes (GB) – Data Transferred
BillingMonth Required	Replace this variable with the 1st of the month for which billing information will be returned. Format:YYYY-MM-01

If you specify a date other than the 1st of the month, then the return value will not reflect the usage information for that month.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameter:

Name	Data Type	Description
UsageResult	Number floating-point	Indicates the total amount of bandwidth usage or data transferred for the specified billing region, platform, and month. The units for this return parameter are determined by the Units request parameter.

Errors

The response body for an unsuccessful request may contain an error parameter that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is provided below.

A sample JSON response is provided below.

{
	"UsageResult" : 85.5
}

Sample Request and Response (XML)

A sample XML request is provided below.

A sample XML response is provided below.

<UsageResult xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<UsageResult>85.5</UsageResult>
</UsageResult>