Get Current Cache Status Statistics

Provides a breakdown of the cache statuses currently being returned for requests to your CDN account.

Request

A request to cache status statistics is described below.

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

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)

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 parameters for each cache status returned by this endpoint:

Name	Data Type	Description
CacheStatus	String	Indicates the name of the cache status for which statistical information will be returned. Learn more about cache statuses.
Connections	Integer	Indicates the total number of requests per second that resulted in the specified cache status.

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.

A sample JSON response is provided below.

[{
		"CacheStatus" : "TCP_HIT",
		"Connections" : 3550
	}, {
		"CacheStatus" : "TCP_EXPIRED_HIT",
		"Connections" : 1525
	}, {
		"CacheStatus" : "TCP_MISS",
		"Connections" : 125
	}, {
		"CacheStatus" : "TCP_EXPIRED_MISS",
		"Connections" : 0
	}, {
		"CacheStatus" : "TCP_CLIENT_REFRESH_MISS",
		"Connections" : 0
	}, {
		"CacheStatus" : "NONE",
		"Connections" : 0
	}, {
		"CacheStatus" : "CONFIG_NOCACHE",
		"Connections" : 0
	}, {
		"CacheStatus" : "UNCACHEABLE",
		"Connections" : 0
	}
]

Sample Request and Response (XML)

A sample XML request is provided below.

A sample XML response is provided below.

<ArrayOfRealTimeCacheStatus xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<RealTimeCacheStatus>
		<CacheStatus>TCP_HIT</CacheStatus>
		<Connections>3550</Connections>
	</RealTimeCacheStatus>
	<RealTimeCacheStatus>
		<CacheStatus>TCP_EXPIRED_HIT</CacheStatus>
		<Connections>1525</Connections>
	</RealTimeCacheStatus>
	<RealTimeCacheStatus>
		<CacheStatus>TCP_MISS</CacheStatus>
		<Connections>125</Connections>
	</RealTimeCacheStatus>
	<RealTimeCacheStatus>
		<CacheStatus>TCP_EXPIRED_MISS</CacheStatus>
		<Connections>0</Connections>
	</RealTimeCacheStatus>
	<RealTimeCacheStatus>
		<CacheStatus>TCP_CLIENT_REFRESH_MISS</CacheStatus>
		<Connections>0</Connections>
	</RealTimeCacheStatus>
	<RealTimeCacheStatus>
		<CacheStatus>NONE</CacheStatus>
		<Connections>0</Connections>
	</RealTimeCacheStatus>
	<RealTimeCacheStatus>
		<CacheStatus>CONFIG_NOCACHE</CacheStatus>
		<Connections>0</Connections>
	</RealTimeCacheStatus>
	<RealTimeCacheStatus>
		<CacheStatus>UNCACHEABLE</CacheStatus>
		<Connections>0</Connections>
	</RealTimeCacheStatus>
</ArrayOfRealTimeCacheStatus>