Retrieves CDN statistics for the top 250 requested assets over a specified time period.
A request to retrieves CDN statistics on the top requested content is described below.
HTTP Method | Request URI |
---|---|
GET |
https://api.edgecast.com/v2/reporting/customers/AccountNumber/media/Platform/filestats?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 |
---|---|
Required |
|
Required |
Replace this variable with an integer that indicates the platform for which a report will be generated.
|
Required |
Replace this variable with the start date/time for the report. Only activity that took place after the specified date will be included in the report. Format: YYYY-MM-DDThh:mm:ss |
Required |
Replace this variable with the end date/time for the report. Activity that took place after the specified date will not be included in the report. Format: YYYY-MM-DDThh:mm:ss |
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.
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Request body parameters are not required by this endpoint.
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request contains the following response parameters for each asset returned by this endpoint:
Name | Data Type | Description |
---|---|---|
DataTransferred |
Integer |
Indicates the total amount of data transferred (in bytes) for the specified asset over the specified time period. |
DataTransferredPercentage |
Number floating-point |
Indicates the data transferred percentage for the specified asset. This percentage is calculated from the total amount of data transferred for all assets 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. |
Hits |
Integer |
Indicates the total number of hits for the specified asset over the specified time period. |
HitsPercent |
Number floating-point |
Indicates the hits percentage for the specified asset. This percentage is calculated from the total hits for all assets included in this report over the specified time period. |
Path |
String |
Identifies the relative path to the asset for which statistical information is returned. This path starts directly after the hostname. |
The response body for an unsuccessful request may contain an error parameter that provides additional information.
A sample JSON request is provided below.
GET https://api.edgecast.com/v2/reporting/customers/0001/media/3/filestats?begindate=2024-01-01&enddate=2024-02-01 HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/json
Host:api.edgecast.com
A sample JSON response is provided below.
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Date: Thu, 15 Apr 2021 12:00:00 GMT
Content-Length: 654
[{ "DataTransferred" : 29731911100, "DataTransferredPercentage" : 43.7475, "Duration" : 0.5021, "Hits" : 70286037, "HitsPercent" : 81.1283, "Path" : "\/000001\/sales\/main.html" }, { "DataTransferred" : 7161857970, "DataTransferredPercentage" : 10.5428, "Duration" : 0.5224, "Hits" : 15966987, "HitsPercent" : 18.43, "Path" : "\/000001\/sales\/Demo01.ppt" }, { "DataTransferred" : 1954210120, "DataTransferredPercentage" : 2.8679, "Duration" : 0.5226, "Hits" : 176268, "HitsPercent" : 0.2035, "Path" : "\/000001\/sales\/Revenue.xls" }, { "DataTransferred" : 0, "DataTransferredPercentage" : 0, "Duration" : 0.5053, "Hits" : 1, "HitsPercent" : 0, "Path" : "\/000001\/sales\/icon.gif" } ]
A sample XML request is provided below.
GET https://api.edgecast.com/v2/reporting/customers/0001/media/3/filestats?begindate=2024-01-01&enddate=2024-02-01 HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/xml
Host:api.edgecast.com
A sample XML response is provided below.
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Date: Thu, 15 Apr 2021 12:00:00 GMT
Content-Length: 1101
<ArrayOfFile xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <File> <DataTransferred>29731911100</DataTransferred> <DataTransferredPercentage>43.7475</DataTransferredPercentage> <Duration>0.5021</Duration> <Hits>70286037</Hits> <HitsPercent>81.1283</HitsPercent> <Path>/000001/sales/main.html</Path> </File> <File> <DataTransferred>7161857970</DataTransferred> <DataTransferredPercentage>10.5428</DataTransferredPercentage> <Duration>0.5224</Duration> <Hits>15966987</Hits> <HitsPercent>18.43</HitsPercent> <Path>/000001/sales/Demo01.ppt</Path> </File> <File> <DataTransferred>1954210120</DataTransferred> <DataTransferredPercentage>2.8679</DataTransferredPercentage> <Duration>0.5226</Duration> <Hits>176268</Hits> <HitsPercent>0.2035</HitsPercent> <Path>/000001/sales/Revenue.xls</Path> </File> <File> <DataTransferred>0</DataTransferred> <DataTransferredPercentage>0</DataTransferredPercentage> <Duration>0.5053</Duration> <Hits>1</Hits> <HitsPercent>0</HitsPercent> <Path>/000001/sales/icon.gif</Path> </File> </ArrayOfFile>