Lists the available report codes. This list may be filtered by platform.
Report codes are useful for interpreting the results of the Get Data Transferred and Hits by Custom Report Codes endpoint.
Two variations of this request are provided below. The first request retrieves a list of all report codes, while the second request only retrieves report codes associated with the specified platform.
HTTP Method | Request URI |
---|---|
GET |
https://api.edgecast.com/v2/reporting/customers/AccountNumber/reportcodes |
GET |
https://api.edgecast.com/v2/reporting/customers/AccountNumber/reportcodes?mediatypeid=Platform |
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 |
---|---|
Required |
|
Replace this variable with an integer that indicates the platform for which a report will be generated. Valid values are:
If the mediatypeid query string parameter is not specified, then report codes for all platforms will be returned. |
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Request body parameters are not required by this endpoint.
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request contains the following response parameters for each report code returned by this endpoint:
Name | Data Type | Description |
---|---|---|
Description |
String |
Describes a report code. If the report code is for an edge CNAME, then this response parameter will identify the corresponding hostname. |
MediaTypeid |
Integer |
Identifies the platform corresponding to that report code. Valid values are:
|
ReportCode |
Integer |
Identifies a report code. |
The response body for an unsuccessful request may contain an error parameter that provides additional information.
A sample JSON request is provided below.
GET https://api.edgecast.com/v2/reporting/customers/0001/reportcodes 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: 195
[{ "Description" : "secure.example.com", "MediaTypeid" : 3, "ReportCode" : 10000 }, { "Description" : "marketing.example.com", "MediaTypeid" : 3, "ReportCode" : 10001 } ]
A sample XML request is provided below.
GET https://api.edgecast.com/v2/reporting/customers/0001/reportcodes 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: 503
<ArrayOfReportCodeGetResults xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ReportCodeGetResults> <Description>secure.example.com</Description> <MediaTypeid>3</MediaTypeid> <ReportCode>10000</ReportCode> </ReportCodeGetResults> <ReportCodeGetResults> <Description>marketing.example.com</Description> <MediaTypeid>3</MediaTypeid> <ReportCode>10001</ReportCode> </ReportCodeGetResults> </ArrayOfReportCodeGetResults>