Synthetic monitor executions API v2 - GET full info on an execution

Gets full results of an on-demand execution of a synthetic monitor.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/executions/{executionId}/fullReport
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/executions/{executionId}/fullReport

Authentication

To execute this request, you need an access token with one of the following scopes:

  • syntheticExecutions.read
  • ExternalSyntheticIntegration
  • ReadSyntheticData

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
executionIdinteger

The identifier of the on-demand execution.

pathrequired

Response

Response codes

CodeTypeDescription
200SyntheticOnDemandExecution

Success. The response contains detailed information about the on-demand execution.

400ErrorEnvelope

Failed. The input is invalid.

404ErrorEnvelope

Execution with the given ID doesn't exist.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The SyntheticOnDemandExecution object

Describes the status of an on-demand execution.

ElementTypeDescription
batchIdstring

The identifier of the batch.

customizedScriptObjectNode

Customized script properties for this on-demand batch execution.

dataDeliveryTimestampinteger

The timestamp when whole data set has been collected on server, in UTC milliseconds.

executionIdstring

The identifier of the execution.

executionStagestring

Execution stage.

  • DATA_RETRIEVED
  • EXECUTED
  • NOT_TRIGGERED
  • TIMED_OUT
  • TRIGGERED
  • WAITING
executionTimestampinteger

The timestamp when execution was finished, in UTC milliseconds.

fullResultsExecutionFullResults

Contains extended monitor's execution details.

locationIdstring

The identifier of the location from where the monitor is to be executed.

metadataobject

Metadata map for the execution batch.

monitorIdstring

The identifier of the monitor.

nextExecutionIdinteger

Next execution id for sequential mode.

processingModestring

The processing mode of the execution.

  • DISABLE_PROBLEM_DETECTION
  • EXECUTIONS_DETAILS_ONLY
  • NONE
  • STANDARD
  • UNKNOWN
schedulingTimestampinteger

The scheduling timestamp, in UTC milliseconds.

simpleResultsExecutionSimpleResults

Contains basic results of the monitor's on-demand execution.

sourcestring

The source of the triggering request.

  • API
  • UI
userIdstring

The name of the user who triggered the on-demand execution.

The ObjectNode object

Customized script properties for this on-demand batch execution.

The ExecutionFullResults object

Contains extended monitor's execution details.

ElementTypeDescription
errorCodestring

Error code.

executionStepCountinteger

Number executed steps.

executionStepsExecutionStep[]

Details about the monitor's step execution.

failedStepNamestring

Failed step name.

failedStepSequenceIdinteger

Failed step sequence id.

failureMessagestring

Failure message.

statusstring

Execution status.

The ExecutionStep object

Contains detailed information about the monitor's step execution.

ElementTypeDescription
monitorTypestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • BROWSER -> BMAction
  • HTTP -> MonitorRequestExecutionResult
  • BROWSER
  • HTTP

The ExecutionSimpleResults object

Contains basic results of the monitor's on-demand execution.

ElementTypeDescription
chromeErrorboolean

Informs whether is Chrome error.

engineIdinteger

Synthetic engine id on which monitor was executed.

errorCodestring

Error code.

executedStepsinteger

Number of the executed steps by Synthetic engine

failureMessagestring

Failure message.

hostNameResolutionTimeinteger

A hostname resolution time measured in milliseconds.

httperrorboolean

Informs whether is HTTP error.

peerCertificateExpiryDateinteger

DEPRECATED

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

publicLocationboolean

Flag informs whether request was executed on public location.

redirectionTimeinteger

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

redirectsCountinteger

Number of redirects.

responseBodySizeLimitExceededboolean

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

responseSizeinteger

Request's response size in bytes.

responseStatusCodeinteger

Response status code.

startTimestampinteger

Start timestamp.

statusstring

Execution status.

tcpConnectTimeinteger

A TCP connect time measured in milliseconds.

timeToFirstByteinteger

A time to first byte measured in milliseconds.

tlsHandshakeTimeinteger

A TLS handshake time measured in milliseconds.

totalTimeinteger

A total time measured in milliseconds.

Response body JSON model

{
  "batchId": "22396514015719218",
  "customizedScript": {
    "requests": [
      {
        "sequenceId": "1",
        "url": "https://www.somepage.org",
        "validation": {
          "rules": [
            {
              "passIfFound": "true",
              "type": "httpStatusesList",
              "value": "=201"
            }
          ]
        }
      }
    ]
  },
  "dataDeliveryTimestamp": "1629891701171",
  "executionId": "7002396514015719218",
  "executionStage": "DATA_RETRIEVED",
  "executionTimestamp": "1629891695487",
  "locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA",
  "metadata": {
    "key": "value",
    "version": "1.255.20221022"
  },
  "monitorId": "HTTP_CHECK-6349B98E1CD87352",
  "processingMode": "STANDARD",
  "schedulingTime": "1629891686877",
  "simpleResults": [
    {
      "engineId": "1993198092",
      "executedSteps": "1",
      "healthStatus": "HEALTHY",
      "hostNameResolutionTime": "50",
      "publicLocation": "false",
      "redirectionTime": "576",
      "responseBodySizeLimitExceeded": "false",
      "responseSize": "1530652",
      "responseStatusCode": "200",
      "startTimestamp": "1629891693487",
      "tcpConnectTime": "127",
      "tlsHandshakeTime": "167",
      "totalTime": "955"
    }
  ],
  "source": "API",
  "userId": "someUserIdentifier"
}

Related topics