Get Cache Status Activity

Indicates the total amount of hits over a given time period for each cache status on a specified platform.

Request

A request to retrieve cache status statistics is described below.

HTTP Method	Request URI
GET	https://api.edgecast.com/v2/reporting/customers/AccountNumber/media/Platform/cachestats?begindate=StartDateTime&enddate=EndDateTime

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 8: HTTP Small 14: Application Delivery Network (ADN)
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.

This endpoint returns data in 1 hour intervals (e.g., 00:00:00, 01:00:00, 02:00:00, etc.). Specifying a time that falls in between a 1 hour interval (e.g., 00:50:05) will include all data associated with that hour (e.g., 00:00:00 – 00:59: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 parameters for each cache status returned by this endpoint:

Name	Data Type	Description
Hits	Integer	Indicates the total number of hits for the cache status identified by the Name response body parameter.
Name	String	Identifies a cache status by its name. Learn more about cache statuses.

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.

[{
		"Hits" : 87619673,
		"Name" : "TCP_HIT"
	}, {
		"Hits" : 22725,
		"Name" : "TCP_MISS"
	}, {
		"Hits" : 8750,
		"Name" : "CONFIG_NOCACHE"
	}, {
		"Hits" : 2388,
		"Name" : "UNCACHEABLE"
	}
]

Sample Request and Response (XML)

A sample XML request is provided below.

A sample XML response is provided below.

<ArrayOfCacheStatus xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<CacheStatus>
		<Hits>87619673</Hits>
		<Name>TCP_HIT</Name>
	</CacheStatus>
	<CacheStatus>
		<Hits>22725</Hits>
		<Name>TCP_MISS</Name>
	</CacheStatus>
	<CacheStatus>
		<Hits>8750</Hits>
		<Name>CONFIG_NOCACHE</Name>
	</CacheStatus>
	<CacheStatus>
		<Hits>2388</Hits>
		<Name>UNCACHEABLE</Name>
	</CacheStatus>
</ArrayOfCacheStatus>