• Home
  • Dynatrace API
  • Environment
  • Synthetic v2
  • Monitor executions
  • GET HTTP monitor

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.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GETManaged 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

ParameterTypeDescriptionInRequired
monitorIdstring

Identifier of the HTTP monitor for which last execution result is returned.

pathrequired
resultTypestring

Defines the result type of the last HTTP monitor's execution.

The element can hold these values
  • SUCCESS
  • FAILED
pathrequired
locationIdstring

Filters the results to those executed by specified Synthetic location. Specify the ID of the location.

queryoptional

Response

Response codes

CodeTypeDescription
200MonitorExecutionResults

Success. The response contains detailed data.

Response body objects

The MonitorExecutionResults object

Results of the execution of all HTTP monitor's requests.

ElementTypeDescription
monitorIdstring

Monitor id.

Can be null.

locationsExecutionResultsLocationExecutionResults[]

The list with the results of the requests executed on assigned locations.

Can be null.

The LocationExecutionResults object

Results of the execution HTTP monitor's requests at a given location

ElementTypeDescription
locationIdstring

Location id.

Can be null.

executionIdstring

Execution id.

Can be null.

requestResultsMonitorRequestExecutionResult[]

The list of the monitor's request results executed on this location.

Can be null.

The MonitorRequestExecutionResult object

A result of the execution HTTP monitor's request.

ElementTypeDescription
requestIdstring

Request id.

Can be null.

requestNamestring

Request name.

Can be null.

sequenceNumberinteger

Request's sequence number.

Can be null.

startTimestampinteger

Request start timestamp.

Can be null.

engineIdinteger

VUC's id on which monitor's request was executed.

Can be null.

publicLocationboolean

Flag informs whether request was executed on public location.

Can be null.

urlstring

Request URL address.

Can be null.

methodstring

Request method type.

Can be null.

requestBodystring

Request's request body.

Can be null.

requestHeadersMonitorRequestHeader[]

A list of request's headers

Can be null.

responseStatusCodeinteger

Request's response status code.

Can be null.

responseBodystring

Request's response body.

Can be null.

responseSizeinteger

Request's response size in bytes.

Can be null.

responseBodySizeLimitExceededboolean

A flag indicating that the response payload size limit of 10MB has been exceeded.

Can be null.

responseHeadersMonitorRequestHeader[]

A list of request's response headers

Can be null.

resolvedIpsstring[]

Request's resolved ips.'

Can be null.

healthStatusCodeinteger

Request's health status code.

Can be null.

healthStatusstring

Request's health status.

Can be null.

responseMessagestring

Request's response message.'

Can be null.

peerCertificateExpiryDateinteger

An expiry date of the first SSL certificate from the certificate chain.

Can be null.

peerCertificateDetailsstring

Request's certificate details.

Can be null.

totalTimeinteger

A total request time measured in ms.

Can be null.

hostNameResolutionTimeinteger

A hostname resolution time measured in ms.

Can be null.

tcpConnectTimeinteger

A TCP connect time measured in ms.

Can be null.

tlsHandshakeTimeinteger

A TLS handshake time measured in ms.

Can be null.

timeToFirstByteinteger

A time to first byte measured in ms.

Can be null.

redirectionTimeinteger

Total number of milliseconds spent on handling all redirect requests, measured in ms.

Can be null.

waitingTimeinteger

Waiting time (time to first byte - (DNS lookup time + TCP connect time + TLS handshake time), measured in ms.

Can be null.

redirectsCountinteger

Number of request's redirects.

Can be null.

failureMessagestring

Request's failure message.

Can be null.

The MonitorRequestHeader object

A header of the Http request

ElementTypeDescription
namestring

Header's name.

Can be null.

valuestring

Header's value.

Can be null.

Response body JSON model

json
{ "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": "" } ] } ] }
Related topics
  • Synthetic Monitoring

    Learn about Synthetic Monitoring and how to create a single-URL browser monitor, a browser clickpath, or an HTTP monitor.