Get Current Bandwidth

Indicates the current amount of bandwidth usage on a per platform basis.

Request

A request to retrieve the current amount of bandwidth in use is described below.

HTTP Method	Request URI
GET	https://api.transactcdn.com/v2/realtimestats/customers/AccountNumber/media/Platform/bandwidth

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 left-hand corner of the TCC.
Platform Required	Replace this variable with an integer that indicates the platform for which a report will be generated. The only valid value is: 14: Commerce Acceleration Network (CAN)

Description

AccountNumber

Required

Replace this variable with a customer account number. This account number may be found in the upper left-hand corner of the TCC.

Platform

Required

Replace this variable with an integer that indicates the platform for which a report will be generated.

The only valid value is:

14: Commerce Acceleration Network (CAN)

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
Result	Number floating-point	Indicates the current amount of bandwidth usage for your account on the specified platform. This value is reported in bits per second.

Name

Data Type

Description

Result

Number

floating-point

Indicates the current amount of bandwidth usage for your account on the specified platform. This value is reported in bits per second.

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.transactcdn.com/v2/realtimestats/customers/0001/media/14/bandwidth HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/json

Host:api.transactcdn.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: 31

{
	"Result" : 8059050.365432
}

Sample Request and Response (XML)

A sample XML request is provided below.

GET https://api.transactcdn.com/v2/realtimestats/customers/0001/media/14/bandwidth HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/xml

Host:api.transactcdn.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: 164

<Bandwidth xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Result>8059050.365432</Result>
</Bandwidth>