Get Group Codes

Retrieves a list of the available group codes. Group codes define the type of statistics that will be returned by the Get Edge CNAME Report - Data Transferred or Hits endpoint.

Request

A request to retrieve group codes is described below.

HTTP Method	Request URI
GET	https://api.edgecast.com/v2/reporting/customreport/groupcodetypes

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

Name	Data Type	Description
GroupCode	String	Identifies a type of statistic by its group code. Use this code when generating a report via the Get Edge CNAME Report - Data Transferred or Hits endpoint.
Description	String	Provides a description for the current group code.

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.

[{
		"GroupCode" : "HTTP_STATUS",
		"Description" : "HTTP Response Codes"
	}, {
		"GroupCode" : "LOG_TCP",
		"Description" : "Cache Status"
	}
]

Sample Request and Response (XML)

A sample XML request is provided below.

A sample XML response is provided below.

<ArrayOfGroupCode xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<GroupCode>
		<GroupCode>HTTP_STATUS</GroupCode>
		<Description>HTTP Response Codes</Description>
	</GroupCode>
	<GroupCode>
		<GroupCode>LOG_TCP</GroupCode>
		<Description>Cache Status</Description>
	</GroupCode>
</ArrayOfGroupCode>