Get Hits by Status Code and Platform

Indicates the hit statistics for each status code returned for content delivered over our CDN. The data returned by this report can be filtered to only include CDN traffic that meets the following criteria:

Request

A request to retrieve hit statistics is described below.

HTTP Method Request URI

GET

https://api.edgecast.com/v2/reporting/customers/AccountNumber/media/Platform/hits?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:

  • 0: All Platforms
  • 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 status code.

Name Data Type Description

Description

String

Identifies a status code by its description (e.g., OK, Forbidden, Not Found, etc.)

HitPercentage

Number

floating-point

Indicates the percentage of requests that resulted in the specified status code over the given time period & platform.

Hits

Integer

Indicates the number of requests that resulted in the specified status code over the given time period & platform.

StatusCode

Integer

Identifies a status code (e.g., 200, 403, 404, etc.).

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.edgecast.com/v2/reporting/customers/0001/media/3/hits?begindate=2024-03-01&enddate=2024-04-01 HTTP/1.1

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

Accept: application/json

Host:api.edgecast.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: 487

[{
		"Description" : "",
		"HitPercentage" : 57.96,
		"Hits" : 638045,
		"StatusCode" : 200
	}, {
		"Description" : "",
		"HitPercentage" : 41.36,
		"Hits" : 455247,
		"StatusCode" : 304
	}, {
		"Description" : "",
		"HitPercentage" : 0.43,
		"Hits" : 4698,
		"StatusCode" : 206
	}, {
		"Description" : "",
		"HitPercentage" : 0.25,
		"Hits" : 2799,
		"StatusCode" : 404
	}, {
		"Description" : "",
		"HitPercentage" : 0,
		"Hits" : 2,
		"StatusCode" : 405
	}
]

Sample Request and Response (XML)

A sample XML request is provided below.

GET https://api.edgecast.com/v2/reporting/customers/0001/media/3/hits?begindate=2024-03-01&enddate=2024-04-01 HTTP/1.1

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

Accept: application/xml

Host:api.edgecast.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: 767

<ArrayOfHit xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Hit>
		<Description/>
		<HitPercentage>57.96</HitPercentage>
		<Hits>638045</Hits>
		<StatusCode>200</StatusCode>
	</Hit>
	<Hit>
		<Description/>
		<HitPercentage>41.36</HitPercentage>
		<Hits>455247</Hits>
		<StatusCode>304</StatusCode>
	</Hit>
	<Hit>
		<Description/>
		<HitPercentage>0.43</HitPercentage>
		<Hits>4698</Hits>
		<StatusCode>206</StatusCode>
	</Hit>
	<Hit>
		<Description/>
		<HitPercentage>0.25</HitPercentage>
		<Hits>2799</Hits>
		<StatusCode>404</StatusCode>
	</Hit>
	<Hit>
		<Description/>
		<HitPercentage>0</HitPercentage>
		<Hits>2</Hits>
		<StatusCode>405</StatusCode>
	</Hit>
</ArrayOfHit>