Overview
Search the usage statistics of Edge.
Requests
Request URL
GET
https://edge.apigw.ntruss.com/api/v1/statistics/{profileId}/{edgeId}
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| profileId | Yes | String | Profile number | |
| edgeId | Yes | Integer | Edge number | |
| dateFrom | Yes | String | ISO date format yyyy-MM-dd'T'HH:mm:ssMin: 730 days ago |
Search start date (UTC) |
| dateTo | Yes | String | ISO date format yyyy-MM-dd'T'HH:mm:ss Max: current time |
Search end date (UTC) |
Responses
All responses return success or failure as HTTP Status Code.
| HTTP status code | Code message | Description |
|---|---|---|
| 200 | Success | Search succeeded |
| 401 | Unauthorized | Authentication failed |
| 500 | Internal Server Error | Server error |
StatisticsSummary
| Item | Type | Description |
|---|---|---|
| dateFrom | ZonedDateTime | Statistics view start time (UTC) |
| dateTo | ZonedDateTime | Statistics view end time (UTC) |
| interval | Long | Statistical data interval (seconds) |
| hitsTotal | HitsTotal | Summary of statistics related to all requests |
| hitsTotal.offload.value | Double | Overall offload average |
| hitsTotal.offload.min | Double | Minimum offload of all stats |
| hitsTotal.offload.max | Double | Maximum offload of all stats |
| hitsTotal.edgeHits.value | Long | Total Edge Hit |
| hitsTotal.edgeHits.min | Long | Minimum Edge Hit of all stats |
| hitsTotal.edgeHits.max | Long | Maximum Edge Hit of all stats |
| hitsTotal.originShieldHits.value | Long | Total Origin Shield Hits |
| hitsTotal.originShieldHits.min | Long | Minimum Origin shield Hit of all stats |
| hitsTotal.originShieldHits.max | Long | Maximum Origin shield Hit of all stats |
| hitsTotal.originHits.value | Long | Total Origin Hits |
| hitsTotal.originHits.min | Long | Minimum Origin Hit of all stats |
| hitsTotal.originHits.max | Long | Maximum Origin Hit of all stats |
| hitsTotal.errorHits.value | Long | Total Error Hits |
| hitsTotal.errorHits.min | Long | Minimum Error Hit of all stats |
| hitsTotal.errorHits.max | Long | Maximum Error Hit of all stats |
| bytesTotal.offload.value | Double | Overall offload traffic average |
| bytesTotal.offload.min | Double | Minimum offload traffic of all stats |
| bytesTotal.offload.max | Double | Maximum offload traffic of all stats |
| bytesTotal.edgeBytes.value | Long | Total Edge Traffic (Byte) |
| bytesTotal.edgeBytes.min | Long | Minimum Edge Traffic of all stats |
| bytesTotal.edgeBytes.max | Long | Maximum Edge Traffic of all stats |
| bytesTotal | BytesTotal | Summary of statistics related to total traffic (byte) |
| bytesTotal.originShieldBytes.value | Long | Total Origin shield Traffic (byte) |
| bytesTotal.originShieldBytes.min | Long | Minimum Origin shield Traffic of all stats |
| bytesTotal.originShieldBytes.max | Long | Maximum Origin shield Traffic of all stats |
| bytesTotal.originBytes.value | Long | Total Origin Traffic (byte) |
| bytesTotal.originBytes.min | Long | Minimum Origin Traffic of all stats |
| bytesTotal.originBytes.max | Long | Maximum Origin Traffic of all stats |
| bytesTotal.errorHits.value | Long | Total Error Hits |
| bytesTotal.errorHits.min | Long | Minimum Error Hit of all stats |
| bytesTotal.errorHits.max | Long | Maximum Error Hit of all stats |
| responseSegments | List<ResponseSegment> | Statistical data by HTTP response code |
| responseSegments[].responseCode | String 2xx / 3xx / 4xx / 5xx |
HTTP response code |
| responseSegments[].edgeHits | Long | Total Edge response code occurrences |
| responseSegments[].originHits | Long | Total Origin response code occurrences |
| trafficSegments | List<TrafficSegments> | Statistical data by Edge |
| trafficSegments[].edgeId | Long | Edge number |
| trafficSegments[].edgeName | String | Edge name |
| trafficSegments[].offloadHits | Double | Edge Hit offload average |
| trafficSegments[].edgeHits | Long | Total Edge Hit occurrences of instances |
| trafficSegments[].originHits | Long | Total Origin Hit occurrences of instances |
| trafficSegments[].offloadBytes | Double | Edge traffic (byte) offload average |
| trafficSegments[].edgeBytes | Long | Total Edge traffic (byte) occurrences of instances |
| trafficSegments[].originShieldBytes | Long | Total Origin Shield traffic (byte) occurrences of instances |
| trafficSegments[].originBytes | Long | Total Origin traffic (byte) occurrences of instances |
| statistics | List<ChartValue> | Statistics aggregated by Timestamp |
| statistics[].time | ZonedDateTime | Statistics collection time (UTC) |
| statistics[].offloadHits | Double | Offload average for the time period |
| statistics[].edgeHits | Long | Total Edge Hit occurrences in the time period |
| statistics[].originShieldHits | Long | Total Origin Shield Hit occurrences in the time period |
| statistics[].originHits | Long | Total Origin Hit occurrences in the time period |
| statistics[].edgeSuccessCount | Long | Total Edge 2xx response occurrences in the time period |
| statistics[].edgeRedirectionCount | Long | Total Edge 3xx response occurrences in the time period |
| statistics[].edgeClientErrorCount | Long | Total Edge 4xx response occurrences in the time period |
| statistics[].edgeServerErrorCount | Long | Total Edge 5xx response occurrences in the time period |
| statistics[].originSuccessCount | Long | Total Origin 2xx response occurrences in the time period |
| statistics[].originRedirectionCount | Long | Total Origin 3xx response occurrences in the time period |
| statistics[].originClientErrorCount | Long | Total Origin 4xx response occurrences in the time period |
| statistics[].originServerErrorCount | Long | Total Origin 5xx response occurrences in the time period |
| statistics[].offloadBytes | Double | Traffic (bytes) offload average for the time period |
| statistics[].edgeBps | Double | Total Edge traffic (bytes) occurrences in the time period |
| statistics[].originShieldBps | Double | Total Origin Shield traffic (bytes) occurrences in the time period |
| statistics[].originBps | Double | Total Origin traffic (bytes) occurrences in the time period |
Examples
Request examples
https://edge.apigw.ntruss.com/api/v1/statistics/123/456?dateFrom=2022-11-14T09:25:12.340Z&dateTo=2022-11-16T09:25:12.340Z
Response examples
{
"code":"0000",
"message":"Success",
"result":{
"dateFrom":"2022-11-14T00:00:00Z",
"dateTo":"2022-11-16T09:25:16.137098912Z",
"interval":3600,
"hitsTotal":{
"offload":{
"value":0.0,
"min":0.0,
"max":0.0
},
"edgeHits":{
"value":0,
"min":0,
"max":0
},
"originShieldHits":{
"value":0,
"min":0,
"max":0
},
"originHits":{
"value":0,
"min":0,
"max":0
},
"errorHits":{
"value":0,
"min":0,
"max":0
}
},
"bytesTotal":{
"offload":{
"value":0.0,
"min":0.0,
"max":0.0
},
"edgeBytes":{
"value":0,
"min":0,
"max":0
},
"originShieldBytes":{
"value":0,
"min":0,
"max":0
},
"originBytes":{
"value":0,
"min":0,
"max":0
},
"errorHits":{
"value":0,
"min":0,
"max":0
}
},
"responseSegments":[
{
"responseCode":"2xx",
"edgeHits":0,
"originHits":0
},
{
"responseCode":"3xx",
"edgeHits":0,
"originHits":0
},
{
"responseCode":"4xx",
"edgeHits":0,
"originHits":0
},
{
"responseCode":"5xx",
"edgeHits":0,
"originHits":0
}
],
"trafficSegments":[
{
"edgeId":469,
"edgeName":"choi-edge-001",
"offloadHits":0.0,
"edgeHits":0,
"originHits":0,
"offloadBytes":0.0,
"edgeBytes":0,
"originShieldBytes":0,
"originBytes":0
}
],
"statistics":[
{
"time":"2022-11-14T00:00:00Z",
"offloadHits":0.0,
"edgeHits":0,
"originShieldHits":0,
"originHits":0,
"edgeSuccessCount":0,
"edgeRedirectionCount":0,
"edgeClientErrorCount":0,
"edgeServerErrorCount":0,
"originSuccessCount":0,
"originRedirectionCount":0,
"originClientErrorCount":0,
"originServerErrorCount":0,
"offloadBytes":0.0,
"edgeBps":0.0,
"originShieldBps":0.0,
"originBps":0.0
},
...(ellipsis)...
{
"time":"2022-11-16T08:00:00Z",
"offloadHits":0.0,
"edgeHits":0,
"originShieldHits":0,
"originHits":0,
"edgeSuccessCount":0,
"edgeRedirectionCount":0,
"edgeClientErrorCount":0,
"edgeServerErrorCount":0,
"originSuccessCount":0,
"originRedirectionCount":0,
"originClientErrorCount":0,
"originServerErrorCount":0,
"offloadBytes":0.0,
"edgeBps":0.0,
"originShieldBps":0.0,
"originBps":0.0
}
]
}
}
Errors
| Error code | Description |
|---|---|
| 0032 | Request not allowed |
| 0400 | Request data format mismatch |
| 0401 | End date cannot be earlier than start date |
| 0402 | Statistical date range exceeded |
| 9999 | Server error occurred |