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 Access problem and event feed, metrics, and topology (DataExport) permission assigned to your API token. 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 | optional |
| resultType | string | Defines the result type of the last HTTP monitor's execution. | path | optional |
| locationId | string | Filters the results to those executed by specified Synthetic location. Specify the ID of the location. | query | required |
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 | Required |
|---|---|---|---|
| monitorId | string | Monitor id. | optional |
| locationsExecutionResults | Location | The list with the results of the requests executed on assigned locations. | optional |
The LocationExecutionResults object
Results of the execution HTTP monitor's requests at a given location
| Element | Type | Description | Required |
|---|---|---|---|
| locationId | string | Location id. | optional |
| executionId | string | Execution id. | optional |
| requestResults | Monitor | The list of the monitor's request results executed on this location. | optional |
The MonitorRequestExecutionResult object
A result of the execution HTTP monitor's request.
| Element | Type | Description | Required |
|---|---|---|---|
| requestId | string | Request id. | optional |
| requestName | string | Request name. | optional |
| sequenceNumber | integer | Request's sequence number. | optional |
| startTimestamp | integer | Request start timestamp. | optional |
| engineId | integer | VUC's id on which monitor's request was executed. | optional |
| publicLocation | boolean | Flag informs whether request was executed on public location. | optional |
| url | string | Request URL address. | optional |
| method | string | Request method type. | optional |
| requestBody | string | Request's request body. | optional |
| requestHeaders | Monitor | A list of request's headers | optional |
| responseStatusCode | integer | Request's response status code. | optional |
| responseBody | string | Request's response body. | optional |
| responseSize | integer | Request's response size in bytes. | optional |
| responseBodySizeLimitExceeded | boolean | A flag indicating that the response payload size limit of 10MB has been exceeded. | optional |
| responseHeaders | Monitor | A list of request's response headers | optional |
| resolvedIps | string[] | Request's resolved ips.' | optional |
| healthStatusCode | integer | Request's health status code. | optional |
| healthStatus | string | Request's health status. | optional |
| responseMessage | string | Request's response message.' | optional |
| peerCertificateExpiryDate | integer | An expiry date of the first SSL certificate from the certificate chain. | optional |
| peerCertificateDetails | string | Request's certificate details. | optional |
| totalTime | integer | A total request time measured in ms. | optional |
| hostNameResolutionTime | integer | A hostname resolution time measured in ms. | optional |
| tcpConnectTime | integer | A TCP connect time measured in ms. | optional |
| tlsHandshakeTime | integer | A TLS handshake time measured in ms. | optional |
| timeToFirstByte | integer | A time to first byte measured in ms. | optional |
| redirectionTime | integer | Total number of milliseconds spent on handling all redirect requests, measured in ms. | optional |
| waitingTime | integer | Waiting time (time to first byte - (DNS lookup time + TCP connect time + TLS handshake time), measured in ms. | optional |
| redirectsCount | integer | Number of request's redirects. | optional |
| failureMessage | string | Request's failure message. | optional |
The MonitorRequestHeader object
A header of the Http request
| Element | Type | Description | Required |
|---|---|---|---|
| name | string | Header's name. | optional |
| value | string | Header's value. | optional |
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": ""
}
]
}
]
}