Get Data Transferred and Hits by Custom Report Codes

Indicates the number of hits and the total amount of data transferred for each custom report code.

A unique custom report code is associated with each edge CNAME for which the custom report capability has been enabled.

Request

A request to retrieve CDN activity for each custom report code is described below.

HTTP Method	Request URI
GET	https://api.edgecast.com/v2/reporting/customers/AccountNumber/media/Platform/cnamereportcodes?begindate=StartDateTime&enddate=EndDateTime

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 8: HTTP Small 14: Application Delivery Network (ADN)
StartDateTime Required	Replace this variable with the start date/time for the report. Only activity that took place after the specified date/time will be included in the report. Format: YYYY-MM-DD
EndDateTime Required	Replace this variable with the end date/time for the report. Activity that took place after the specified date/time will not be included in the report. Format: YYYY-MM-DD

Learn more about date/time format.

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 parameters for each report code returned by this endpoint:

Name	Data Type	Description
Bytes	Integer	Indicates the total amount of data transferred (in bytes) for the specified report code. Keep in mind that this data is filtered by time period and platform.
Description	String	Provides a description for a report code. The provided information varies according to report code type. For example, if an edge CNAME has been associated with a report code, then this response parameter will report the name of that edge CNAME.
Hits	Integer	Indicates the total number of hits that occurred for the specified report code. Keep in mind that this data is filtered by time period and platform.
ReportCode	Integer	Identifies a report code by its system-defined ID.

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.

[{
		"Bytes" : 55515129610593,
		"Description" : "www.edgecname1.com",
		"Hits" : 21873348,
		"ReportCode" : 10042
	}, {
		"Bytes" : 45792193956438,
		"Description" : "www.edgecname2.com",
		"Hits" : 34243537,
		"ReportCode" : 10044
	}
]

Sample Request and Response (XML)

A sample XML request is provided below.

A sample XML response is provided below.

<ArrayOfCnameReportCodes xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<CnameReportCodes>
		<Bytes>55515129610593</Bytes>
		<Description>www.edgecname1.com</Description>
		<Hits>21873348</Hits>
		<ReportCode>10001</ReportCode>
	</CnameReportCodes>
	<CnameReportCodes>
		<Bytes>45792193956438</Bytes>
		<Description>www.edgecname2.com</Description>
		<Hits>34243537</Hits>
		<ReportCode>10002</ReportCode>
	</CnameReportCodes>
</ArrayOfCnameReportCodes>