MENU
      Search Edge statistics
        • PDF

        Search Edge statistics

        • PDF

        Article summary

        Overview

        Search the usage statistics of Edge.

        Requests

        Request URL

        GET
        https://edge.apigw.ntruss.com/api/v1/statistics/{profileId}/{edgeId}
        Plain text

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        profileIdYesStringProfile number
        edgeIdYesIntegerEdge number
        dateFromYesStringISO date format
        yyyy-MM-dd'T'HH:mm:ss
        Min: 730 days ago
        Search start date
        (UTC)
        dateToYesStringISO 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 codeCode messageDescription
        200SuccessSearch succeeded
        401UnauthorizedAuthentication failed
        500Internal Server ErrorServer error

        StatisticsSummary

        ItemTypeDescription
        dateFromZonedDateTimeStatistics view start time (UTC)
        dateToZonedDateTimeStatistics view end time (UTC)
        intervalLongStatistical data interval (seconds)
        hitsTotalHitsTotalSummary of statistics related to all requests
        hitsTotal.offload.valueDoubleOverall offload average
        hitsTotal.offload.minDoubleMinimum offload of all stats
        hitsTotal.offload.maxDoubleMaximum offload of all stats
        hitsTotal.edgeHits.valueLongTotal Edge Hit
        hitsTotal.edgeHits.minLongMinimum Edge Hit of all stats
        hitsTotal.edgeHits.maxLongMaximum Edge Hit of all stats
        hitsTotal.originShieldHits.valueLongTotal Origin Shield Hits
        hitsTotal.originShieldHits.minLongMinimum Origin shield Hit of all stats
        hitsTotal.originShieldHits.maxLongMaximum Origin shield Hit of all stats
        hitsTotal.originHits.valueLongTotal Origin Hits
        hitsTotal.originHits.minLongMinimum Origin Hit of all stats
        hitsTotal.originHits.maxLongMaximum Origin Hit of all stats
        hitsTotal.errorHits.valueLongTotal Error Hits
        hitsTotal.errorHits.minLongMinimum Error Hit of all stats
        hitsTotal.errorHits.maxLongMaximum Error Hit of all stats
        bytesTotal.offload.valueDoubleOverall offload traffic average
        bytesTotal.offload.minDoubleMinimum offload traffic of all stats
        bytesTotal.offload.maxDoubleMaximum offload traffic of all stats
        bytesTotal.edgeBytes.valueLongTotal Edge Traffic (Byte)
        bytesTotal.edgeBytes.minLongMinimum Edge Traffic of all stats
        bytesTotal.edgeBytes.maxLongMaximum Edge Traffic of all stats
        bytesTotalBytesTotalSummary of statistics related to total traffic (byte)
        bytesTotal.originShieldBytes.valueLongTotal Origin shield Traffic (byte)
        bytesTotal.originShieldBytes.minLongMinimum Origin shield Traffic of all stats
        bytesTotal.originShieldBytes.maxLongMaximum Origin shield Traffic of all stats
        bytesTotal.originBytes.valueLongTotal Origin Traffic (byte)
        bytesTotal.originBytes.minLongMinimum Origin Traffic of all stats
        bytesTotal.originBytes.maxLongMaximum Origin Traffic of all stats
        bytesTotal.errorHits.valueLongTotal Error Hits
        bytesTotal.errorHits.minLongMinimum Error Hit of all stats
        bytesTotal.errorHits.maxLongMaximum Error Hit of all stats
        responseSegmentsList<ResponseSegment>Statistical data by HTTP response code
        responseSegments[].responseCodeString
        2xx / 3xx / 4xx / 5xx
        HTTP response code
        responseSegments[].edgeHitsLongTotal Edge response code occurrences
        responseSegments[].originHitsLongTotal Origin response code occurrences
        trafficSegmentsList<TrafficSegments>Statistical data by Edge
        trafficSegments[].edgeIdLongEdge number
        trafficSegments[].edgeNameStringEdge name
        trafficSegments[].offloadHitsDoubleEdge Hit offload average
        trafficSegments[].edgeHitsLongTotal Edge Hit occurrences of instances
        trafficSegments[].originHitsLongTotal Origin Hit occurrences of instances
        trafficSegments[].offloadBytesDoubleEdge traffic (byte) offload average
        trafficSegments[].edgeBytesLongTotal Edge traffic (byte) occurrences of instances
        trafficSegments[].originShieldBytesLongTotal Origin Shield traffic (byte) occurrences of instances
        trafficSegments[].originBytesLongTotal Origin traffic (byte) occurrences of instances
        statisticsList<ChartValue>Statistics aggregated by Timestamp
        statistics[].timeZonedDateTimeStatistics collection time (UTC)
        statistics[].offloadHitsDoubleOffload average for the time period
        statistics[].edgeHitsLongTotal Edge Hit occurrences in the time period
        statistics[].originShieldHitsLongTotal Origin Shield Hit occurrences in the time period
        statistics[].originHitsLongTotal Origin Hit occurrences in the time period
        statistics[].edgeSuccessCountLongTotal Edge 2xx response occurrences in the time period
        statistics[].edgeRedirectionCountLongTotal Edge 3xx response occurrences in the time period
        statistics[].edgeClientErrorCountLongTotal Edge 4xx response occurrences in the time period
        statistics[].edgeServerErrorCountLongTotal Edge 5xx response occurrences in the time period
        statistics[].originSuccessCountLongTotal Origin 2xx response occurrences in the time period
        statistics[].originRedirectionCountLongTotal Origin 3xx response occurrences in the time period
        statistics[].originClientErrorCountLongTotal Origin 4xx response occurrences in the time period
        statistics[].originServerErrorCountLongTotal Origin 5xx response occurrences in the time period
        statistics[].offloadBytesDoubleTraffic (bytes) offload average for the time period
        statistics[].edgeBpsDoubleTotal Edge traffic (bytes) occurrences in the time period
        statistics[].originShieldBpsDoubleTotal Origin Shield traffic (bytes) occurrences in the time period
        statistics[].originBpsDoubleTotal 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
        Plain text

        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
                 }
              ]
           }
        }
        JSON

        Errors

        Error codeDescription
        0032Request not allowed
        0400Request data format mismatch
        0401End date cannot be earlier than start date
        0402Statistical date range exceeded
        9999Server error occurred

        Was this article helpful?

        What's Next
        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.