Get Current Edge CNAME Statistics II

Reports summarized and POP-specific real-time statistics for:

The response for this endpoint may be filtered to only return statistics for a single edge CNAME.

Learn how real-time statistics are calculated.

Request

A request to retrieve real-time statistics broken down by edge CNAME is described below.

HTTP Method Request URI

GET

https://api.transactcdn.com/v2/reporting/customers/AccountNumber/realtimestats/adn?cname=EdgeCNAME

Define the following variable 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.

EdgeCNAME

Replace this variable with the desired edge CNAME.

Including the cname query string parameter when requesting this endpoint will filter the response to only display statistics for the specified edge CNAME.

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 response parameters that report statistics for:

POP locations that are not serving traffic for the relevant edge CNAMEs will be omitted from the response.

Name Data Type Description

Timestamp

String

Identifies the date and time for which real-time statistics was reported.

Format: MM\/DD\/YYYY hh:mm:ss

Time is indicated using 24-hour clock notation in UTC.

Learn more about date/time format.

POPs

Array

Contains real-time statistics for each eligible edge CNAME.

POPCode

String

POPs array

Indicates the scope for the statistics reported by the RTStats response parameter.

Valid values are:

  • Blank: A blank value indicates that the reported real-time statistics are for the entire network.
  • POP: If this response parameter is set to a three-letter POP code, then real-time statistics are only being reported for that POP location.

    View a list of POPs.

RTStats

Array

POPs array

This response parameter contains real-time statistics for each qualifying edge CNAME. The scope for these statistics is determined by the POPCode response parameter.

CName

String

POPs array > RTStats array

Determines the scope for which real-time statistics will be reported.

Valid values are:

  • Edge CNAME: This term identifies an edge CNAME by its name. Indicates that the current object reports real-time statistics for this edge CNAME.
  • Total: Indicates the current object reports real-time statistics for all traffic being delivered over the specified platform.

    Total traffic will not be reported when requesting real-time statistics for a specific edge CNAME using the cname query string parameter.

BW

Number

floating-point

POPs array > RTStats array

Indicates bandwidth, in bytes per second, for the scope defined in the CName response parameter.

CONN

Number

floating-point

POPs array > RTStats array

Indicates the number of new connections per second for the scope defined in the CName response parameter.

HITS

Number

floating-point

POPs array > RTStats array

Indicates the number of hits per second for the scope defined in the CName response parameter.

cache.cfg-nocache

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a CONFIG_NOCACHE for the scope defined in the CName response parameter.

Learn more.

cache.cli-refresh-miss

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a TCP_CLIENT_REFRESH_MISS for the scope defined in the CName response parameter.

Learn more.

cache.hit

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a TCP_HIT for the scope defined in the CName response parameter.

Learn more.

cache.miss

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a TCP_MISS for the scope defined in the CName response parameter.

Learn more.

cache.none

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a NONE for the scope defined in the CName response parameter.

Learn more.

cache.not-cacheable

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a UNCACHEABLE for the scope defined in the CName response parameter.

Learn more.

cache.xphit

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a TCP_EXPIRED_HIT for the scope defined in the CName response parameter.

Learn more.

cache.xpmiss

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a TCP_EXPIRED_MISS for the scope defined in the CName response parameter.

Learn more.

http.2xx

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a 2xx status code (e.g., 200, 201, 202, etc.) for the scope defined in the CName response parameter.

http.304

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a 304 Not Modified status code for the scope defined in the CName response parameter.

http.3xx

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a 3xx status code (e.g., 300, 301, 302, etc.) for the scope defined in the CName response parameter.

This statistic excludes occurrences of the 304 Not Modified status code.

http.403

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a 403 Forbidden status code for the scope defined in the CName response parameter.

http.404

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a 404 Not Found status code for the scope defined in the CName response parameter.

http.4xx

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a 4xx status code (e.g., 400, 401, 402, 405, etc.) for the scope defined in the CName response parameter.

This statistic excludes occurrences of the 403 Not Found and 404 Forbidden status codes.

http.5xx

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a 5xx status code (e.g., 500, 501, 502, etc.) for the scope defined in the CName response parameter.

http.other

Number

floating-point

POPs array > RTStats array

Indicates the number of requests per second that resulted in a status code that is not listed above for the scope defined in the CName response parameter.

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/reporting/customers/0001/realtimestats/adn/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: 9341

{
	"Timestamp": "05\/11\/2022 01:01:44",
	"POPs": [{
			"POPCode": "",
			"RTStats": [{
					"CName": "Total",
					"BW": 5259365.455232,
					"CONN": 484.023106,
					"HITS": 389.403189,
					"cache.cfg-nocache": 135.771434,
					"cache.hit": 40.703439,
					"cache.miss": 0.34,
					"cache.none": 212.571649,
					"cache.xphit": 0.016667,
					"http.2xx": 376.380349,
					"http.304": 5.484814,
					"http.3xx": 7.215299,
					"http.404": 0.322727
				}
			]
		}, {
			"POPCode": "atz",
			"RTStats": [{
					"CName": "Total",
					"BW": 21.133333,
					"CONN": 0.033333,
					"HITS": 0.033333,
					"cache.cfg-nocache": 0.033333,
					"http.2xx": 0.016667,
					"http.304": 0.016667
				}
			]
		}, {
			"POPCode": "cpz",
			"RTStats": [{
					"CName": "Total",
					"BW": 1321.150006,
					"CONN": 0.15,
					"HITS": 0.1,
					"cache.hit": 0.016667,
					"cache.none": 0.083333,
					"http.2xx": 0.1
				}
			]
		}, {
			"POPCode": "dcz",
			"RTStats": [{
					"CName": "Total",
					"BW": 3073.146953,
					"CONN": 0.529545,
					"HITS": 0.479545,
					"cache.cfg-nocache": 0.206061,
					"cache.hit": 0.134091,
					"cache.none": 0.139394,
					"http.2xx": 0.345455,
					"http.304": 0.134091
				}
			]
		}, {
			"POPCode": "ewz",
			"RTStats": [{
					"CName": "Total",
					"BW": 28.333333,
					"CONN": 0.033333,
					"HITS": 0.033333,
					"cache.cfg-nocache": 0.033333,
					"http.2xx": 0.033333
				}
			]
		}, {
			"POPCode": "ftz",
			"RTStats": [{
					"CName": "Total",
					"BW": 939458.265915,
					"CONN": 129.129845,
					"HITS": 105.57965,
					"cache.cfg-nocache": 42.442663,
					"cache.miss": 0.133788,
					"cache.none": 63.003199,
					"http.2xx": 101.804121,
					"http.304": 1.319394,
					"http.3xx": 2.306286,
					"http.404": 0.149848
				}
			]
		}, {
			"POPCode": "jfz",
			"RTStats": [{
					"CName": "Total",
					"BW": 2596031.608798,
					"CONN": 230.859951,
					"HITS": 182.249182,
					"cache.cfg-nocache": 58.146352,
					"cache.hit": 33.908317,
					"cache.miss": 0.146212,
					"cache.none": 90.048301,
					"http.2xx": 176.145822,
					"http.304": 2.729372,
					"http.3xx": 3.26111,
					"http.404": 0.112879
				}
			]
		}, {
			"POPCode": "lhz",
			"RTStats": [{
					"CName": "Total",
					"BW": 717.98329,
					"CONN": 0.446515,
					"HITS": 0.331667,
					"cache.cfg-nocache": 0.1,
					"cache.none": 0.231667,
					"http.2xx": 0.298333,
					"http.3xx": 0.033333
				}
			]
		}, {
			"POPCode": "mdz",
			"RTStats": [{
					"CName": "Total",
					"BW": 195687.834972,
					"CONN": 36.682152,
					"HITS": 30.250771,
					"cache.cfg-nocache": 9.07999,
					"cache.hit": 6.133607,
					"cache.none": 15.020509,
					"cache.xphit": 0.016667,
					"http.2xx": 29.362592,
					"http.304": 0.348624,
					"http.3xx": 0.539555
				}
			]
		}, {
			"POPCode": "miz",
			"RTStats": [{
					"CName": "Total",
					"BW": 1521854.456542,
					"CONN": 85.860401,
					"HITS": 70.097676,
					"cache.cfg-nocache": 25.630006,
					"cache.hit": 0.494091,
					"cache.miss": 0.06,
					"cache.none": 43.91358,
					"http.2xx": 68.055995,
					"http.304": 0.92,
					"http.3xx": 1.061681,
					"http.404": 0.06
				}
			]
		}, {
			"POPCode": "orz",
			"RTStats": [{
					"CName": "Total",
					"BW": 28.433333,
					"CONN": 0.033333,
					"HITS": 0.033333,
					"cache.cfg-nocache": 0.033333,
					"http.2xx": 0.033333
				}
			]
		}, {
			"POPCode": "sez",
			"RTStats": [{
					"CName": "Total",
					"BW": 1143.108757,
					"CONN": 0.264697,
					"HITS": 0.214697,
					"cache.cfg-nocache": 0.066364,
					"cache.hit": 0.016667,
					"cache.none": 0.131667,
					"http.2xx": 0.184697,
					"http.304": 0.016667,
					"http.3xx": 0.013333
				}
			]
		}
	]
}