Retrieves the total amount of data transferred (bytes) across all platforms over a specific time period.
This endpoint excludes 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 is described below.
HTTP Method | Request URI |
---|---|
GET |
https://api.edgecast.com/v2/reporting/customers/AccountNumber/bytestransferred?begindate=StartDateTime&enddate=EndDateTime&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. Limit report data to one or more POPs by replacing this variable with a comma-delimited list of the desired POPs 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. |
This endpoint returns data in 5 minute intervals (e.g., 00:00:00, 00:05:00, 00:10:00, etc.). Specifying a time that falls in between a 5 minute interval (e.g., 00:02:59) will include all data associated with that 5 minute interval (e.g., 00:00:00 – 00:04:59).
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 parameter:
Name | Data Type | Description |
---|---|---|
Bytes |
Integer |
Indicates the number of bytes transferred over the given time period. This statistic includes CDN activity for all platforms. The pops request parameter determines whether this endpoint returns the amount of data transferred for the entire CDN network or if it will be limited to specific POP locations. |
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?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: 43
{ "Bytes" : 257764320845815459845511324 }
A sample XML request is provided below.
GET https://api.edgecast.com/v2/reporting/customers/0001/bytestransferred?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: 156
<BytesResult xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Bytes>257764320845815459845511324</Bytes> </BytesResult>