Which endpoint should I use to retrieve real-time statistics by edge CNAME?
Various endpoints retrieve real-time statistics by edge CNAME. These endpoints vary according to how real-time statistics are reported. Determine which endpoint is right for you by cross-referencing your answers to the following questions with the endpoint comparison table.
- Do you need real-time statistics on a per country basis?
- Do you need real-time statistics on a per POP basis?
- Do you need a timestamp that identifies the date and time at which the data was retrieved?
The response structure varies across these endpoints. This difference does not affect the provided feature set.
| Endpoint | Country |
POP |
Timestamp |
|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reports summarized and POP-specific real-time statistics for:
- All traffic delivered over a specific platform.
-
Platform-specific traffic for each edge CNAME that meets the following requirements:
- The edge CNAME's Custom Reports option is set to "Enabled."
- Traffic is being served through the edge CNAME.
The response for this endpoint may be filtered to only return statistics for a single edge CNAME.
Learn how real-time statistics are calculated.
Request
A request to retrieve real-time statistics broken down by edge CNAME is described below.
| HTTP Method | Request URI |
|---|---|
|
GET |
https://api.edgecast.com/v2/reporting/customers/AccountNumber/realtimestats/Platform?cname=EdgeCNAME |
Define the following variable 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 |
|
|
Required |
Replace this variable with the platform for which real-time statistics will be reported. Valid values are:
|
|
Replace this variable with the desired edge CNAME. Including the cname query string parameter when requesting this endpoint will filter the response to only display statistics for the specified edge CNAME. |
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.
Response Body
The response body for a successful request contains response parameters that report statistics for:
- All POPs (i.e., total).
- Each POP location.
POP locations that are not serving traffic for the relevant edge CNAMEs will be omitted from the response.
| Name | Data Type | Description |
|---|---|---|
|
Timestamp |
String |
Identifies the date and time for which real-time statistics was reported. Format: MM\/DD\/YYYY hh:mm:ss Time is indicated using 24-hour clock notation in UTC. |
|
POPs |
Array |
Contains real-time statistics for each eligible edge CNAME. |
|
POPCode |
String |
POPs array Indicates the scope for the statistics reported by the RTStats response parameter. Valid values are:
|
|
RTStats |
Array |
POPs array This response parameter contains real-time statistics for each qualifying edge CNAME. The scope for these statistics is determined by the POPCode response parameter. |
|
CName |
String |
POPs array > RTStats array Determines the scope for which real-time statistics will be reported. Valid values are:
|
|
BW |
Number floating-point |
POPs array > RTStats array Indicates bandwidth, in bytes per second, for the scope defined in the CName response parameter. |
|
CONN |
Number floating-point |
POPs array > RTStats array Indicates the number of new connections per second for the scope defined in the CName response parameter. |
|
HITS |
Number floating-point |
POPs array > RTStats array Indicates the number of hits per second for the scope defined in the CName response parameter. |
|
cache.cfg-nocache |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a CONFIG_NOCACHE for the scope defined in the CName response parameter. |
|
cache.cli-refresh-miss |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a TCP_CLIENT_REFRESH_MISS for the scope defined in the CName response parameter. |
|
cache.hit |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a TCP_HIT for the scope defined in the CName response parameter. |
|
cache.miss |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a TCP_MISS for the scope defined in the CName response parameter. |
|
cache.none |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a NONE for the scope defined in the CName response parameter. |
|
cache.not-cacheable |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a UNCACHEABLE for the scope defined in the CName response parameter. |
|
cache.xphit |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a TCP_EXPIRED_HIT for the scope defined in the CName response parameter. |
|
cache.xpmiss |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a TCP_EXPIRED_MISS for the scope defined in the CName response parameter. |
|
http.2xx |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a 2xx status code (e.g., 200, 201, 202, etc.) for the scope defined in the CName response parameter. |
|
http.304 |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a 304 Not Modified status code for the scope defined in the CName response parameter. |
|
http.3xx |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a 3xx status code (e.g., 300, 301, 302, etc.) for the scope defined in the CName response parameter. |
|
http.403 |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a 403 Forbidden status code for the scope defined in the CName response parameter. |
|
http.404 |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a 404 Not Found status code for the scope defined in the CName response parameter. |
|
http.4xx |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a 4xx status code (e.g., 400, 401, 402, 405, etc.) for the scope defined in the CName response parameter. |
|
http.5xx |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a 5xx status code (e.g., 500, 501, 502, etc.) for the scope defined in the CName response parameter. |
|
http.other |
Number floating-point |
POPs array > RTStats array Indicates the number of requests per second that resulted in a status code that is not listed above for the scope defined in the CName response parameter. |
Errors
The response body for an unsuccessful request may contain an error parameter that provides additional information.
Sample Request and Response (JSON)
A sample JSON request is provided below.
GET https://api.edgecast.com/v2/reporting/customers/0001/realtimestats/adn/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: 9341
{
"Timestamp": "01\/28\/2024 22:00:29",
"POPs": [{
"POPCode": "",
"RTStats": [{
"CName": "cdn.example.com",
"BW": 305298.047064,
"CONN": 5.766566,
"HITS": 4.949867,
"cache.hit": 4.066534,
"cache.miss": 0.8,
"cache.xphit": 0.083333,
"http.2xx": 4.949867
}, {
"CName": "secure.example.com",
"BW": 84.483333,
"CONN": 0.016667,
"HITS": 0.016667,
"cache.hit": 0.016667,
"http.2xx": 0.016667
}, {
"CName": "Total",
"BW": 308285.651727,
"CONN": 10.235139,
"HITS": 9.224092,
"cache.hit": 7.968059,
"cache.miss": 0.989236,
"cache.xphit": 0.266797,
"http.2xx": 8.894094,
"http.304": 0.329998
}
]
}, {
"POPCode": "arn",
"RTStats": [{
"CName": "cdn.example.com",
"BW": 584.833341,
"CONN": 0.366667,
"HITS": 0.366667,
"cache.hit": 0.366667,
"http.2xx": 0.366667
}, {
"CName": "Total",
"BW": 593.062281,
"CONN": 0.375759,
"HITS": 0.375759,
"cache.hit": 0.375759,
"http.2xx": 0.375759
}
]
}, {
"POPCode": "cgh",
"RTStats": [{
"CName": "secure.example.com",
"BW": 495.479424,
"CONN": 0.133341,
"HITS": 0.100008,
"cache.hit": 0.083341,
"cache.miss": 0.016667,
"http.2xx": 0.100008
}, {
"CName": "cdn.example.com",
"BW": 883.650031,
"CONN": 0.6,
"HITS": 0.55,
"cache.hit": 0.416667,
"cache.miss": 0.133333,
"http.2xx": 0.55
}, {
"CName": "Total",
"BW": 2166.60638,
"CONN": 0.875109,
"HITS": 0.791775,
"cache.hit": 0.641775,
"cache.miss": 0.15,
"cache.xphit": -7E-06,
"http.2xx": 0.791775
}
]
}, {
"POPCode": "cgk",
"RTStats": [{
"CName": "secure.example.com",
"BW": 82270.343017,
"CONN": 1.583229,
"HITS": 1.583229,
"cache.hit": 1.566563,
"cache.miss": 0.016667,
"http.2xx": 1.583229
}, {
"CName": "cdn.example.com",
"BW": 2802.70006,
"CONN": 1.866667,
"HITS": 1.85,
"cache.hit": 1.85,
"http.2xx": 1.733333,
"http.304": 0.116667
}, {
"CName": "Total",
"BW": 85218.39222,
"CONN": 3.297718,
"HITS": 3.281051,
"cache.hit": 3.267415,
"cache.miss": 0.013636,
"http.2xx": 3.164384,
"http.304": 0.116667
}
]
}, {
"POPCode": "cjb",
"RTStats": [{
"CName": "secure.example.com",
"BW": 17208.551549,
"CONN": 0.066667,
"HITS": 0.05,
"cache.hit": 0.033333,
"cache.miss": 0.016667,
"http.2xx": 0.05
}, {
"CName": "Total",
"BW": 17293.033204,
"CONN": 0.083328,
"HITS": 0.066662,
"cache.hit": 0.05,
"cache.miss": 0.016667,
"http.2xx": 0.066662
}
]
}, {
"POPCode": "den",
"RTStats": [{
"CName": "Total",
"BW": 14.94415,
"CONN": 0.009096,
"HITS": 0.009096,
"cache.miss": 0.009096,
"http.2xx": 0.009096
}
]
}, {
"POPCode": "frf",
"RTStats": [{
"CName": "cdn.example.com",
"BW": 318.999993,
"CONN": 0.2,
"HITS": 0.2,
"cache.hit": 0.2,
"http.2xx": 0.2
}, {
"CName": "Total",
"BW": 319.000001,
"CONN": 0.2,
"HITS": 0.2,
"cache.hit": 0.2,
"http.2xx": 0.2
}
]
}, {
"POPCode": "hhp",
"RTStats": [{
"CName": "cdn.example.com",
"BW": 120.533335,
"CONN": 0.233333,
"HITS": 0.233333,
"cache.hit": 0.216667,
"cache.xphit": 0.016667,
"http.2xx": 0.033333,
"http.304": 0.2
}, {
"CName": "Total",
"BW": 120.533333,
"CONN": 0.233333,
"HITS": 0.233333,
"cache.hit": 0.216667,
"cache.miss": -3E-06,
"cache.xphit": 0.016667,
"http.2xx": 0.033333,
"http.304": 0.2
}
]
}, {
"POPCode": "khh",
"RTStats": [{
"CName": "cdn.example.com",
"BW": 218.099996,
"CONN": 0.15,
"HITS": 0.15,
"cache.hit": 0.15,
"http.2xx": 0.133333,
"http.304": 0.016667
}, {
"CName": "Total",
"BW": 295.190352,
"CONN": 0.191704,
"HITS": 0.191704,
"cache.hit": 0.191642,
"http.2xx": 0.183369,
"http.304": 0.008336
}
]
}, {
"POPCode": "lga",
"RTStats": [{
"CName": "cdn.example.com",
"BW": 12.266668,
"CONN": 0.033333,
"HITS": 0.016667,
"cache.miss": 0.016667,
"http.2xx": 0.016667
}, {
"CName": "Total",
"BW": 12.266667,
"CONN": 0.033333,
"HITS": 0.016667,
"cache.miss": 0.016667,
"http.2xx": 0.016667
}
]
}, {
"POPCode": "lhr",
"RTStats": [{
"CName": "cdn.example.com",
"BW": 276.666639,
"CONN": 0.25,
"HITS": 0.166667,
"cache.hit": 0.083333,
"cache.xphit": 0.083333,
"http.2xx": 0.166667
}, {
"CName": "Total",
"BW": 276.666664,
"CONN": 0.25,
"HITS": 0.166667,
"cache.hit": 0.083333,
"cache.xphit": 0.083333,
"http.2xx": 0.166667
}
]
}, {
"POPCode": "mia",
"RTStats": [{
"CName": "cdn.example.com",
"BW": 24.666668,
"CONN": 0.05,
"HITS": 0.033333,
"cache.hit": 0.016667,
"cache.miss": 0.016667,
"http.2xx": 0.033333
}, {
"CName": "Total",
"BW": 24.666667,
"CONN": 0.05,
"HITS": 0.033333,
"cache.hit": 0.016667,
"cache.miss": 0.016667,
"http.2xx": 0.033333
}
]
}, {
"POPCode": "mxp",
"RTStats": [{
"CName": "secure.example.com",
"BW": 65505.736493,
"CONN": 0.416632,
"HITS": 0.366632,
"cache.hit": 0.349966,
"cache.miss": 0.016667,
"http.2xx": 0.366632
}, {
"CName": "cdn.example.com",
"BW": 26.583335,
"CONN": 0.016667,
"HITS": 0.016667,
"cache.hit": 0.016667,
"http.2xx": 0.016667
}, {
"CName": "Total",
"BW": 65847.772781,
"CONN": 0.439697,
"HITS": 0.383632,
"cache.hit": 0.360901,
"cache.miss": 0.016667,
"cache.xphit": 0.006065,
"http.2xx": 0.383632
}
]
}, {
"POPCode": "pox",
"RTStats": [{
"CName": "secure.example.com",
"BW": 1381.2501,
"CONN": 0.083333,
"HITS": 0.066667,
"cache.hit": 0.05,
"cache.miss": 0.016667,
"http.2xx": 0.066667
}, {
"CName": "cdn.example.com",
"CONN": -5.1E-05,
"HITS": -5.1E-05,
"cache.hit": -5.1E-05,
"http.2xx": -5.1E-05
}, {
"CName": "Total",
"BW": 1381.249995,
"CONN": 0.083333,
"HITS": 0.066667,
"cache.hit": 0.05,
"cache.miss": 0.016667,
"http.2xx": 0.066667
}
]
}, {
"POPCode": "sin",
"RTStats": [{
"CName": "secure.example.com",
"BW": 24430.884746,
"CONN": 1.249997,
"HITS": 1.249997,
"cache.hit": 1.249997,
"http.2xx": 1.249997
}, {
"CName": "cdn.example.com",
"BW": 834.350043,
"CONN": 0.516667,
"HITS": 0.516667,
"cache.hit": 0.416667,
"cache.miss": 0.033333,
"cache.xphit": 0.066667,
"http.2xx": 0.516667
}, {
"CName": "Total",
"BW": 26017.700089,
"CONN": 1.776526,
"HITS": 1.776526,
"cache.hit": 1.673222,
"cache.miss": 0.036655,
"cache.xphit": 0.066648,
"http.2xx": 1.77153,
"http.304": 0.004996
}
]
}, {
"POPCode": "tka",
"RTStats": [{
"CName": "cdn.example.com",
"BW": 28.749997,
"CONN": 0.016667,
"HITS": 0.016667,
"cache.xphit": 0.016667,
"http.2xx": 0.016667
}, {
"CName": "Total",
"BW": 15.677212,
"CONN": 0.018176,
"HITS": 0.009088,
"cache.xphit": 0.009088,
"http.2xx": 0.009088
}
]
}, {
"POPCode": "uio",
"RTStats": [{
"CName": "Total",
"BW": 433.3686,
"CONN": 0.005003,
"HITS": 0.005003,
"cache.miss": 0.005003,
"http.2xx": 0.005003
}
]
}, {
"POPCode": "vie",
"RTStats": [{
"CName": "secure.example.com",
"BW": 79761.801613,
"CONN": 1.750033,
"HITS": 1.05,
"cache.hit": 0.25,
"cache.miss": 0.716667,
"cache.xphit": 0.083333,
"http.2xx": 1.05
}, {
"CName": "cdn.example.com",
"BW": 11.949999,
"CONN": 0.016667,
"HITS": 0.016667,
"cache.hit": 0.016667,
"http.2xx": 0.016667
}, {
"CName": "Total",
"BW": 76024.653956,
"CONN": 1.732539,
"HITS": 1.036646,
"cache.hit": 0.260137,
"cache.miss": 0.691512,
"cache.xphit": 0.084996,
"http.2xx": 1.036646
}
]
}, {
"POPCode": "waw",
"RTStats": [{
"CName": "secure.example.com",
"BW": 34244.000122,
"CONN": 0.483333,
"HITS": 0.483333,
"cache.hit": 0.483333,
"http.2xx": 0.483333
}, {
"CName": "Total",
"BW": 32230.867176,
"CONN": 0.580479,
"HITS": 0.580479,
"cache.hit": 0.580479,
"http.2xx": 0.580479
}
]
}
]
}