Retrieves a list of the available metric codes. Metric codes define the type of report that will be returned by the Get Edge CNAME Report - Data Transferred or Hits endpoint.
A request to retrieve metric codes is described below.
HTTP Method | Request URI |
---|---|
GET |
https://api.edgecast.com/v2/reporting/customreport/metriccodetypes |
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 metric code returned by this endpoint:
Name | Data Type | Description |
---|---|---|
MetricCode |
String |
Identifies a type of report by its metric 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 metric 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/customreport/metriccodetypes 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: 130
[{ "MetricCode" : "Hits", "Description" : "Hits" }, { "MetricCode" : "DT", "Description" : "Data Transferred" } ]
A sample XML request is provided below.
GET https://api.edgecast.com/v2/reporting/customreport/metriccodetypes 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: 337
<ArrayOfMetricCode xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <MetricCode> <MetricCode>Hits</MetricCode> <Description>Hits</Description> </MetricCode> <MetricCode> <MetricCode>DT</MetricCode> <Description>Data Transferred</Description> </MetricCode> </ArrayOfMetricCode>