Synthetic monitor executions API v2 - GET HTTP monitor
Gets the result of the most recent execution of the specified HTTP monitor.
The request produces an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/execution/{monitorId}/{resultType} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/execution/{monitorId}/{resultType} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/execution/{monitorId}/{resultType} |
Authentication
To execute this request, you need an access token with Access problem and event feed, metrics, and topology (DataExport) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| monitorId | string | Identifier of the HTTP monitor for which last execution result is returned. | path | required |
| resultType | string | Defines the result type of the last HTTP monitor's execution. | path | required |
| locationId | string | Filters the results to those executed by specified Synthetic location. Specify the ID of the location. | query | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Monitor | Success. The response contains detailed data. |
Response body objects
The MonitorExecutionResults object
Results of the execution of all HTTP monitor's requests.
| Element | Type | Description |
|---|---|---|
| monitorId | string | Monitor id. Can be |
| locationsExecutionResults | Location | The list with the results of the requests executed on assigned locations. Can be |
The LocationExecutionResults object
Results of the execution HTTP monitor's requests at a given location
| Element | Type | Description |
|---|---|---|
| locationId | string | Location id. Can be |
| executionId | string | Execution id. Can be |
| requestResults | Monitor | The list of the monitor's request results executed on this location. Can be |
The MonitorRequestExecutionResult object
A result of the execution HTTP monitor's request.
| Element | Type | Description |
|---|---|---|
| requestId | string | Request id. Can be |
| requestName | string | Request name. Can be |
| sequenceNumber | integer | Request's sequence number. Can be |
| startTimestamp | integer | Request start timestamp. Can be |
| engineId | integer | VUC's id on which monitor's request was executed. Can be |
| publicLocation | boolean | Flag informs whether request was executed on public location. Can be |
| url | string | Request URL address. Can be |
| method | string | Request method type. Can be |
| requestBody | string | Request's request body. Can be |
| requestHeaders | Monitor | A list of request's headers Can be |
| responseStatusCode | integer | Request's response status code. Can be |
| responseBody | string | Request's response body. Can be |
| responseSize | integer | Request's response size in bytes. Can be |
| responseBodySizeLimitExceeded | boolean | A flag indicating that the response payload size limit of 10MB has been exceeded. Can be |
| responseHeaders | Monitor | A list of request's response headers Can be |
| resolvedIps | string[] | Request's resolved ips.' Can be |
| healthStatusCode | integer | Request's health status code. Can be |
| healthStatus | string | Request's health status. Can be |
| responseMessage | string | Request's response message.' Can be |
| peerCertificateExpiryDate | integer | An expiry date of the first SSL certificate from the certificate chain. Can be |
| peerCertificateDetails | string | Request's certificate details. Can be |
| totalTime | integer | A total request time measured in ms. Can be |
| hostNameResolutionTime | integer | A hostname resolution time measured in ms. Can be |
| tcpConnectTime | integer | A TCP connect time measured in ms. Can be |
| tlsHandshakeTime | integer | A TLS handshake time measured in ms. Can be |
| timeToFirstByte | integer | A time to first byte measured in ms. Can be |
| redirectionTime | integer | Total number of milliseconds spent on handling all redirect requests, measured in ms. Can be |
| waitingTime | integer | Waiting time (time to first byte - (DNS lookup time + TCP connect time + TLS handshake time), measured in ms. Can be |
| redirectsCount | integer | Number of request's redirects. Can be |
| failureMessage | string | Request's failure message. Can be |
The MonitorRequestHeader object
A header of the Http request
| Element | Type | Description |
|---|---|---|
| name | string | Header's name. Can be |
| value | string | Header's value. Can be |
Response body JSON model
{
"monitorId": "HTTP_CHECK-12B428F6D37A9197",
"locationsExecutionResults": [
{
"locationId": "7804738439930364165",
"executionId": "6136172183050046113",
"requestResults": [
{
"requestId": "HTTP_CHECK_STEP-53071FC3C4F72E28",
"requestName": "Request name",
"sequenceNumber": 1,
"startTimestamp": 1615806570884,
"engineId": 338502283,
"publicLocation": false,
"url": "https://www.examplePage.com",
"method": "GET",
"requestBody": "",
"requestHeaders": [
{
"name": "User-Agent",
"value": "DynatraceSynthetic/1.215.1"
},
{
"name": "X-Dynatrace-Visit",
"value": "6136172183050046113"
},
{
"name": "X-Dynatrace-Test",
"value": "HTTP_CHECK-12B428F6D37A9197"
}
],
"responseStatusCode": 200,
"responseBody": "<html><head>Title</head><body>Main Page</body></html>",
"responseSize": 1112,
"responseBodySizeLimitExceeded": false,
"responseHeaders": [
{
"name": "Date",
"value": "Mon, 15 Mar 2021 11:09:30 GMT"
},
{
"name": "Content-Language",
"value": "en"
}
],
"resolvedIps": [
"80.252.0.145"
],
"errorCode": 0,
"responseMessage": "OK",
"peerCertificateExpiryDate": 1647302399000,
"peerCertificateDetails": "[Certificate details]",
"totalTime": 238,
"hostNameResolutionTime": 26,
"tcpConnectTime": 15,
"tlsHandshakeTime": 8,
"timeToFirstByte": 96,
"redirectionTime": 70,
"waitingTime": 47,
"redirectsCount": 1,
"failureMessage": ""
}
]
}
]
}