Show search and navigation.

 

Get Current Status Codes Statistics

Provides a breakdown of the status codes currently being returned for HTTP requests to your CDN account.

Request

A request for status code statistics is described below.

HTTP Method Request URI

GET

https://api.transactcdn.com/v2/realtimestats/customers/AccountNumber/media/Platform/statuscode

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 status code returned by this endpoint:

Name Data Type Description

Connections

Integer

Indicates the total number of requests per second that resulted in the specified status code.

StatusCode

String

Indicates the type of status code for which statistical information will be returned.

Valid return values are listed below.

  • 2xx: Indicates the total number of requests per second for the specified platform that result in a 2xx status code (e.g., 200, 201, 202, etc.).
  • 304: Indicates the number of requests per second for the specified platform that result in a 304 Not Modified status code.

  • 3xx: Indicates the total number of requests per second for the specified platform that result in a 3xx status code (e.g., 300, 301, 302, etc.).

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

  • 403: Indicates the number of requests per second for the specified platform that result in a 403 Forbidden status code.
  • 404: Indicates the number of requests per second for the specified platform that result in a 404 Not Found status code.

  • 4xx: Indicates the total number of requests per second for the specified platform that result in a 4xx status code (e.g., 400, 401, 402, etc.).

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

  • 5xx: Indicates the total number of requests per second for the specified platform that result in a 5xx status code (e.g., 500, 501, 502, etc.).
  • Other: This category is a catch-all for all status codes not covered by any of the above status codes.

Learn more about common status codes.

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/statuscode 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: 407

[{
		"Connections" : 5600,
		"StatusCode" : "2xx"
	}, {
		"Connections" : 0,
		"StatusCode" : "304"
	}, {
		"Connections" : 0,
		"StatusCode" : "3xx"
	}, {
		"Connections" : 0,
		"StatusCode" : "403"
	}, {
		"Connections" : 0,
		"StatusCode" : "404"
	}, {
		"Connections" : 0,
		"StatusCode" : "4xx"
	}, {
		"Connections" : 0,
		"StatusCode" : "5xx"
	}, {
		"Connections" : 0,
		"StatusCode" : "other"
	}
]

Sample Request and Response (XML)

A sample XML request is provided below.

GET https://api.transactcdn.com/v2/realtimestats/customers/0001/media/14/statuscode 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: 1072

<ArrayOfRealTimeStatusCode xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<RealTimeStatusCode>
		<Connections>5600</Connections>
		<StatusCode>2xx</StatusCode>
	</RealTimeStatusCode>
	<RealTimeStatusCode>
		<Connections>0</Connections>
		<StatusCode>304</StatusCode>
	</RealTimeStatusCode>
	<RealTimeStatusCode>
		<Connections>0</Connections>
		<StatusCode>3xx</StatusCode>
	</RealTimeStatusCode>
	<RealTimeStatusCode>
		<Connections>0</Connections>
		<StatusCode>403</StatusCode>
	</RealTimeStatusCode>
	<RealTimeStatusCode>
		<Connections>0</Connections>
		<StatusCode>404</StatusCode>
	</RealTimeStatusCode>
	<RealTimeStatusCode>
		<Connections>0</Connections>
		<StatusCode>4xx</StatusCode>
	</RealTimeStatusCode>
	<RealTimeStatusCode>
		<Connections>0</Connections>
		<StatusCode>5xx</StatusCode>
	</RealTimeStatusCode>
	<RealTimeStatusCode>
		<Connections>0</Connections>
		<StatusCode>other</StatusCode>
	</RealTimeStatusCode>
</ArrayOfRealTimeStatusCode>