Get Download Activity

Indicates download statistics for the top 250 downloaded assets over a specific time period.

Key information:

• This report only provides information for assets larger than 50 KB.
• Reports generated for accounts on which compression has been enabled may be inaccurate, since the logged file size may be larger than the total bytes transferred.
• This report may not accurately represent streaming video downloads, since users may seek to different parts of the video.

Request

A request to retrieve download statistics is described below.

HTTP Method	Request URI
GET	https://api.edgecast.com/v2/reporting/customers/AccountNumber/media/Platform/completedownloads?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 14: Application Delivery Network (ADN)
StartDateTime Required	Replace this variable with the start date for the report. Only activity that took place after the specified date will be included in the report. Format: YYYY-MM-DD
EndDateTime Required	Replace this variable with the end date for the report. Activity that took place after the specified date will not be included in the report. Format: YYYY-MM-DD

This endpoint returns data in 1 day intervals. This means that this report will return data for the specified time period including the specified start and end date. This will occur regardless of whether a time value was specified. This means that time is optional and irrelevant for this endpoint.

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 asset returned by this endpoint:

Name	Data Type	Description
CompleteDownloadPercent	Number floating-point	Indicates the percentage that the entire asset was downloaded. A decimal value is not reported for whole numbers (e.g., 100).
CompleteDownloads	Integer	Indicates the total number of times that the entire asset was downloaded.
DownloadAttempts	Integer	Indicates the total number of attempts to download the specified asset.
File	String	Indicates the relative path to an asset. This path starts directly after the hostname.

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.

[{
		"CompleteDownloadPercent" : 81.33,
		"CompleteDownloads" : 4952436300,
		"DownloadAttempts" : 4952436298,
		"File" : "\/000001\/sales\/Main.html"
	}, {
		"CompleteDownloadPercent" : 18.33,
		"CompleteDownloads" : 1116424040,
		"DownloadAttempts" : 1116424040,
		"File" : "\/000001\/Resources\/Video01.flv"
	}, {
		"CompleteDownloadPercent" : 0.16,
		"CompleteDownloads" : 9525486,
		"DownloadAttempts" : 9525474,
		"File" : "\/000001\/Resources\/Border.gif"
	}
]

Sample Request and Response (XML)

A sample XML request is provided below.

A sample XML response is provided below.

<ArrayOfDownload xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Download>
		<CompleteDownloadPercent>81.33</CompleteDownloadPercent>
		<CompleteDownloads>4952436300</CompleteDownloads>
		<DownloadAttempts>4952436298</DownloadAttempts>
		<File>/000001/sales/Main.html</File>
	</Download>
	<Download>
		<CompleteDownloadPercent>18.33</CompleteDownloadPercent>
		<CompleteDownloads>1116424040</CompleteDownloads>
		<DownloadAttempts>1116424040</DownloadAttempts>
		<File>/000001/Resources/Video01.flv</File>
	</Download>
	<Download>
		<CompleteDownloadPercent>0.16</CompleteDownloadPercent>
		<CompleteDownloads>9525486</CompleteDownloads>
		<DownloadAttempts>9525474</DownloadAttempts>
		<File>/000001/Resources/Border.gif</File>
	</Download>
</ArrayOfDownload>