Get monitoring results
- Print
- PDF
Get monitoring results
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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:
| Method | URI |
|---|---|
| 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:
| Field | Type | Required | Description |
|---|---|---|---|
scenarioId | Integer | Required | Scenario ID
|
Request query parameters
You can use the following query parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
from | Long | Required | Query start time
|
to | Long | Required | Query end time
|
type | String | Required | Monitoring result data type
|
resultStatus | String | Optional | Monitoring result
|
locationTypeCodes | String | Optional | Country where the monitoring measurement agent is located
|
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' \
Response
This section describes the response format.
Response body
The response body includes the following data:
| Field | Type | Required | Description |
|---|---|---|---|
avgLoadTime | Integer | - | Average page load time (millisecond) |
avgRunTime | Integer | - | Average scenario execution time (millisecond) |
successCount | Integer | - | Number of normal monitoring results
|
errorCount | Integer | - | Number of errors in monitoring results
|
totalCount | Integer | - | Total number of monitoring results
|
availability | Integer | - | Service availability
|
results | Array | - | Monitoring results |
results
The following describes results.
| Field | Type | Required | Description |
|---|---|---|---|
_id | String | - | Monitoring result ID
|
scenarioId | Integer | - | Scenario ID |
locationTypeCodes | String | Optional | Country where the monitoring measurement agent is located
|
resultStatus | String | Optional | Monitoring result
|
avgLoadTime | Integer | - | Average page load time (millisecond) |
avgRunTime | Integer | - | Average scenario execution time (millisecond) |
collectTime | Long | - | Scenario aggregation base time
|
stime1d | Long | - | Scenario aggregation base date
|
successCount | Integer | - | Number of normal monitoring results
|
errorCount | Integer | - | Number of errors in monitoring results
|
totalCount | Integer | - | Total number of monitoring results
|
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
},
...
]
}
Was this article helpful?