MENU
      Get monitoring results

        Get monitoring results


        Article summary

        Available in Classic and VPC

        Get the 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

        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

        Request query parameters

        You can use the following query parameters with your request:

        FieldTypeRequiredDescription
        fromLongRequiredQuery start time
        • Unix timestamp format
        toLongRequiredQuery end time
        • Unix timestamp format
        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
        resultStatusStringOptionalMonitoring result
        • SUCCESS | ERROR
          • SUCCESS: success
          • ERROR: failure
        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

        Request example

        The request example is as follows:

        curl --location --request GET 'https://wms.apigw.ntruss.com/api/v1/scenarios/{scenarioId}/results?from=1696790400&to=1697404800&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 results

        results

        The following describes results.

        FieldTypeRequiredDescription
        _idString-Monitoring result ID
        • Use as resultId when querying monitoring detailed results
        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

        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": 1408,
          "avgRunTime": 3526,
          "successCount": 720,
          "errorCount": 0,
          "totalCount": 720,
          "availability": 100,
          "results": [
            {
              "_id": "609287d081869e5f2eedeb8a",
              "scenarioId": 1,
              "locationTypeCode": "KR",
              "resultStatus": "SUCCESS",
              "avgLoadTime": 1472,
              "avgRunTime": 3587,
              "collectTime": 1620215700000,
              "stime1d": 1620140400000,
              "successCount": 5,
              "errorCount": 0,
              "totalCount": 5
            },
            {
              "_id": "609287d081869e5f2eedeb8b",
              "scenarioId": 1,
              "locationTypeCode": "JP",
              "resultStatus": "SUCCESS",
              "avgLoadTime": 1383,
              "avgRunTime": 3496,
              "collectTime": 1620215700000,
              "stime1d": 1620140400000,
              "successCount": 5,
              "errorCount": 0,
              "totalCount": 5
            },
        
            ...
        
          ]
        }
        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.