MENU
      Get monitoring detailed results

        Get monitoring detailed results


        Article summary

        Available in Classic and VPC

        Get the detailed results of monitoring services.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        GET/api/v1/scenarios/{scenarioId}/results/{resultId}

        Request headers

        For information about the headers common to all Web service Monitoring System APIs, see Web service Monitoring System request headers.

        Request path parameters

        You can use the following path parameters with your request:

        FieldTypeRequiredDescription
        scenarioIdIntegerRequiredScenario ID
        resultIdIntegerRequiredMonitoring result ID

        Request query parameters

        You can use the following query parameters with your request:

        FieldTypeRequiredDescription
        typeStringRequiredMonitoring result data type
        • RAW | MIN5 | MIN30 | MIN30
          • RAW: all
          • MIN5: 5-minute aggregation
          • MIN30: 30-minute aggregation
          • HOUR2: 2-hour aggregation
          • DAY1: 1-day aggregation

        Request example

        The request example is as follows:

        curl --location --request GET 'https://wms.apigw.ntruss.com/api/v1/scenarios/{scenarioId}/results/{resultId}?type=MIN5' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Content-Type: application/json' \
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        avgLoadTimeInteger-Average page load time (millisecond)
        avgRunTimeInteger-Average scenario execution time (millisecond)
        successCountInteger-Number of normal monitoring results
        • Criteria: query period
        errorCountInteger-Number of errors in monitoring results
        • Criteria: query period
        totalCountInteger-Total number of monitoring results
        • Criteria: query period
        availabilityInteger-Service availability
        • Criteria: query period
        resultsArray-Monitoring detailed results

        results

        The following describes results.

        FieldTypeRequiredDescription
        _idString-Monitoring result ID
        scenarioIdInteger-Scenario ID
        locationTypeCodesStringOptionalCountry where the monitoring measurement agent is located
        • KR | USW | JP | SG | DE
          • KR: Korea
          • USW: United States (West)
          • JP: Japan
          • SG: Singapore
          • DE: Germany
        • Separate with comma (,) when selecting more than one
        resultStatusStringOptionalMonitoring result
        • SUCCESS | ERROR
          • SUCCESS: success
          • ERROR: failure
        avgLoadTimeInteger-Average page load time (millisecond)
        avgRunTimeInteger-Average scenario execution time (millisecond)
        collectTimeLong-Scenario aggregation base time
        • Unix timestamp format
        stime1dLong-Scenario aggregation base date
        • Unix timestamp format
        successCountInteger-Number of normal monitoring results
        • Criteria: query period
        errorCountInteger-Number of errors in monitoring results
        • Criteria: query period
        totalCountInteger-Total number of monitoring results
        • Criteria: query period
        stime5mLong-Scenario aggregation base time (5 minutes)
        stime30mLong-Scenario aggregation base time (30 minutes)
        stime2hLong-Scenario aggregation base time (2 hours)
        startTimeLong-Scenario start time
        endTimeLong-Scenario end time
        transactionsArray-Scenario step execution results

        transactions

        The following describes transactions.

        FieldTypeRequiredDescription
        stepIdInteger-Monitoring scenario step ID
        nameString-Monitoring scenario step name
        resultStatusString-Monitoring scenario step execution result
        • SUCCESS | ERROR
          • SUCCESS: success
          • ERROR: failure
        startTimeLong-Monitoring scenario step start time
        • Unix timestamp format
        endTimeLong-Monitoring scenario step end time
        • Unix timestamp format
        logsArray-Monitoring scenario step execution result logs

        logs

        The following describes logs.

        FieldTypeRequiredDescription
        codeInteger-Error code
        harPathString-HAR file path
        imagePathString-Image file path
        msgString-Error message
        timeLong-Error occurrence time
        • Unix timestamp format
        typeString-Error detection type

        Response status codes

        For information about the HTTP status codes common to all Web service Monitoring System APIs, see Web service Monitoring System response status codes.

        Response example

        The response example is as follows:

        {
          "avgLoadTime": 1472,
          "avgRunTime": 3587,
          "successCount": 5,
          "errorCount": 0,
          "totalCount": 5,
          "availability": 100,
          "results": [
            {
              "_id": "609286c23ca80f493050370e",
              "scenarioId": 1,
              "locationTypeCode": "KR",
              "resultStatus": "SUCCESS",
              "avgLoadTime": 1463,
              "avgRunTime": 3571,
              "collectTime": 1620215460000,
              "stime1d": 1620140400000,
              "successCount": 1,
              "errorCount": 0,
              "totalCount": 1,
              "stime5m": 1620215700000,
              "stime30m": 1620216000000,
              "stime2h": 1620219600000,
              "startTime": 1620215485512,
              "endTime": 1620215489083,
              "transactions": [
                {
                  "transactionId": 35,
                  "name": "NAVER Cloud",
                  "resultStatus": "SUCCESS",
                  "startTime": 1620215485512,
                  "endTime": 1620215489083,
                  "steps": [
                    {
                      "stepId": 82,
                      "name": "URL connection",
                      "resultStatus": "SUCCESS",
                      "startTime": 1620215485527,
                      "endTime": 1620215486990,
                      "logs": []
                    },
                    {
                      "stepId": 83,
                      "name": "Mouse click",
                      "resultStatus": "SUCCESS",
                      "startTime": 1620215486993,
                      "endTime": 1620215487566,
                      "logs": []
                    },
                    {
                      "stepId": 84,
                      "name": "Wait time",
                      "resultStatus": "SUCCESS",
                      "startTime": 1620215487568,
                      "endTime": 1620215488567,
                      "logs": []
                    },
                    {
                      "stepId": 85,
                      "name": "Text input",
                      "resultStatus": "SUCCESS",
                      "startTime": 1620215488569,
                      "endTime": 1620215489082,
                      "logs": []
                    }
                  ]
                }
              ]
            },
        
            ...
        
          ]
        }
        JSON

        Was this article helpful?

        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.