Get Data Transferred by Platform

Indicates the total amount of data transferred over the specified platform in a given time period.

Request

A request to retrieve data transferred information by platform is described below.

HTTP Method Request URI

GET

https://api.edgecast.com/v2/reporting/customers/AccountNumber/media/Platform/bytestransferred?begindate=StartDateTime&enddate=EndDateTime&pops=POPs

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
  • 7: HTTP Large (SSL Traffic Only)
  • 8: HTTP Small
  • 9: HTTP Small (SSL Traffic Only)
  • 14: Application Delivery Network (ADN)
  • 15: Application Delivery Network (ADN) - (SSL Traffic Only)

StartDateTime

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.

Learn more about date/time format.

EndDateTime

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.

Learn more about date/time format.

POPs

Optional. Limit report data to one or more POPs by replacing this variable with a comma-delimited list of the desired POPs (e.g., 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 (e.g., &pops=oxr,dca,mia) from the request to retrieve report data for all POPs.

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).

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 parameter:

Name Data Type Description

Bytes

Integer

Indicates the total number of bytes that were transferred on the specified platform over a given time period.

Keep in mind that 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.

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.

GET https://api.edgecast.com/v2/reporting/customers/0001/media/3/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: 21

{
	"Bytes" : 64457041333
}

Sample Request and Response (XML)

A sample XML request is provided below.

GET https://api.edgecast.com/v2/reporting/customers/0001/media/3/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: 158

<BytesResult xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Bytes>64457041333</Bytes>
</BytesResult>