Get Directory Activity

Indicates CDN statistics for the top 250 requested directories over a specific time period.

Request

A request to retrieve CDN statistics by directory is described below.

HTTP Method	Request URI
GET	https://api.edgecast.com/v2/reporting/customers/AccountNumber/media/Platform/directorystats?begindate=StartDate&enddate=EndDate

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)
StartDate 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
EndDate 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 directory returned by this endpoint:

Name	Data Type	Description
DataTransferred	Integer	Indicates the total amount of data transferred (in bytes) for the specified directory over the specified time period.
DataTransferredPercent	Number floating-point	Indicates the data transferred percentage for the specified directory. This percentage is calculated from the total amount of data transferred for all directories included in this report over the specified time period.
Duration	Number floating-point	Indicates the average amount of time, in seconds, that it took our CDN to serve an asset to a client.
FullDirectoryPath	String	Identifies the relative path to the directory for which statistical information is returned. This path starts directly after the hostname.
Hits	Integer	Indicates the total number of hits for the specified directory over the specified time period.
HitsPercent	Number floating-point	Indicates the hits percentage for the specified directory. This percentage is calculated from the total hits for all directories included in this report over the specified period of time.

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.

[{
		"DataTransferred" : 66872640800,
		"DataTransferredPercent" : 98.381,
		"Duration" : 0.5012,
		"FullDirectoryPath" : "\/000001\/HTML\/",
		"Hits" : 86471638,
		"HitsPercent" : 99.8107
	}, {
		"DataTransferred" : 955630223,
		"DataTransferredPercent" : 1.4,
		"Duration" : 0.5232,
		"FullDirectoryPath" : "\/000001\/HTML\/Resources\/",
		"Hits" : 83859,
		"HitsPercent" : 0.0968
	}, {
		"DataTransferred" : 21474837,
		"DataTransferredPercent" : 0.032,
		"Duration" : 0.5235,
		"FullDirectoryPath" : "\/000001\/HTML\/",
		"Hits" : 53059,
		"HitsPercent" : 0.0612
	}
]

Sample Request and Response (XML)

A sample XML request is provided below.

A sample XML response is provided below.

<ArrayOfDirectory xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Directory>
		<DataTransferred>955630223</DataTransferred>
		<DataTransferredPercent>98.381</DataTransferredPercent>
		<Duration>0.5012</Duration>
		<FullDirectoryPath>/000001/HTML/</FullDirectoryPath>
		<Hits>86471638</Hits>
		<HitsPercent>99.8107</HitsPercent>
	</Directory>
	<Directory>
		<DataTransferred>955630223</DataTransferred>
		<DataTransferredPercent>1.4</DataTransferredPercent>
		<Duration>0.5232</Duration>
		<FullDirectoryPath>/000001/HTML/Resources/</FullDirectoryPath>
		<Hits>83859</Hits>
		<HitsPercent>0.0968</HitsPercent>
	</Directory>
	<Directory>
		<DataTransferred>21474837</DataTransferred>
		<DataTransferredPercent>0.032</DataTransferredPercent>
		<Duration>0.5235</Duration>
		<FullDirectoryPath>/000001/HTML/</FullDirectoryPath>
		<Hits>53059</Hits>
		<HitsPercent>0.0612</HitsPercent>
	</Directory>
</ArrayOfDirectory>