Indicates the amount of data transferred (bytes) for your CDN account. The data returned by this report can be filtered to only include CDN traffic that meets the following criteria:
The traffic that meets the above criteria is returned in chunks. The time interval for each chunk may also be defined.
This endpoint does not include data for transactions that did not complete during the requested time period, even if the transaction started before or during the time period covered by the report.
A request to retrieve data transferred information by time interval is described below.
| HTTP Method | Request URI |
|---|---|
|
GET |
https://api.edgecast.com/v2/reporting/customers/AccountNumber/bytestransferred/interval?begindate=StartDateTime&enddate=EndDateTime&mediatypeid=Platform&intervalid=Interval&pops=POPs®ionid=RegionID |
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 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-DDThh:mm:ss Note: Time (i.e., Thh:mm:ss) is optional. If time is not specified, then a default time (i.e., 00:00:00) will be used. |
|
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-DDThh:mm:ss Note: Time (i.e., Thh:mm:ss) is optional. If time is not specified, then a default time (i.e., 00:00:00) will be used. |
|
Optional. Replace this variable with an integer that indicates the platform for which a report will be generated. Valid values are:
If the mediatypeid query string parameter is not specified, then report data for all platforms will be returned. |
|
|
Optional. Replace this variable with an integer that indicates the time interval that will be used to return report data. Valid values are:
If the intervalid query string parameter is not specified, then report data will be returned in five minute intervals. |
|
|
Optional. Limit report data to one or more POPs by replacing this variable with a comma-delimited list of the desired POPs. Example:
oxr,dca,mia
Use the Get All Edge Nodes endpoint to retrieve a list of POPs and their codes. Exclude the pops query string parameter The pops and regionid query string parameters are mutually exclusive. Specifying both query string parameters will result in an error. |
|
|
Optional. Limit report data to a specific region by replacing this variable with the ID of the desired region. Use the Get Billing Regions endpoint to retrieve a list of regions and their IDs. Exclude the regionid query string parameter®ionid=0 from the request to retrieve report data for all regions. The pops and regionid query string parameters are mutually exclusive. Specifying both query string parameters will result in an error. |
Specifying a time that falls in between the time interval specified for this endpoint (e.g., 00:04:59) will retrieve all data associated with that time interval (e.g., 00:00:00 – 00:04:59).
The specified time interval cannot exceed 45 days.
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:
| Name | Data Type | Description |
|---|---|---|
|
AN |
String |
A string that identifies a customer by its system-defined account number. |
|
MediaTypeId |
Integer |
An integer that identifies the platform for which statistics are being reported. Valid values are:
|
|
Data |
Array |
This response parameter contains a set of time slices that report the amount of data transferred over the specified platform and time period. The number and frequency of time slices is determined by the intervalid request parameter. If a platform is not specified in the request URI, then an instance of this response parameter will be returned for each platform. This will occur regardless of whether CDN activity took place for that platform. |
|
DateTimeSlice |
String |
Data array A string that identifies a time slice by its start date and time. Format: YYYY-MM-DD hh:mm |
|
Bytes |
Integer |
Data array An integer that indicates the number of bytes that were transferred during a specific time slice for the specified platform. This value only includes traffic that met the criteria specified in the GET request. |
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/bytestransferred/interval?begindate=2024-02-01&enddate=2024-02-01T05:00:00&mediatypeid=3&intervalid=2 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: 538
[{
"AN" : "0001",
"MediaTypeId" : 3,
"Data" : [{
"DateTimeSlice" : "2024-02-01 00:00",
"Bytes" : 516514354
}, {
"DateTimeSlice" : "2024-02-01 01:00",
"Bytes" : 465465452
}, {
"DateTimeSlice" : "2024-02-01 02:00",
"Bytes" : 688465452
}, {
"DateTimeSlice" : "2024-02-01 03:00",
"Bytes" : 789456321
}, {
"DateTimeSlice" : "2024-02-01 04:00",
"Bytes" : 623845975
}, {
"DateTimeSlice" : "2024-02-01 05:00",
"Bytes" : 689746521
}
]
}
]
A sample XML request is provided below.
GET https://api.edgecast.com/v2/reporting/customers/0001/bytestransferred/interval?begindate=2024-02-01&enddate=2024-02-01T05:00:00&mediatypeid=3&intervalid=2 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: 1203
<ArrayOfCustomerDataTransferredAPI xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <CustomerDataTransferredAPI> <AN>0001</AN> <MediaTypeId>3</MediaTypeId> <Data> <DataTransferred> <DateTimeSlice>2024-02-01 00:00</DateTimeSlice> <Bytes>516514354</Bytes> </DataTransferred> <DataTransferred> <DateTimeSlice>2024-02-01 01:00</DateTimeSlice> <Bytes>465465452</Bytes> </DataTransferred> <DataTransferred> <DateTimeSlice>2024-02-01 02:00</DateTimeSlice> <Bytes>688465452</Bytes> </DataTransferred> <DataTransferred> <DateTimeSlice>2024-02-01 03:00</DateTimeSlice> <Bytes>789456321</Bytes> </DataTransferred> <DataTransferred> <DateTimeSlice>2024-02-01 04:00</DateTimeSlice> <Bytes>623845975</Bytes> </DataTransferred> <DataTransferred> <DateTimeSlice>2024-02-01 05:00</DateTimeSlice> <Bytes>689746521</Bytes> </DataTransferred> </Data> </CustomerDataTransferredAPI> </ArrayOfCustomerDataTransferredAPI>