Synthetic monitor executions API v2 - GET basic info of an execution

Gets basic 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}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/executions/{executionId}

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

Parameter
Type
Description
In
Required
executionId
integer

The identifier of the on-demand execution.

path
required

Response

Response codes

Code
Type
Description
200

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

400

Failed. The input is invalid.

404

Execution with the given ID doesn't exist.

4XX

Client side error.

5XX

Server side error.

Response body objects

The SyntheticOnDemandExecution object

Describes the status of an on-demand execution.

Element
Type
Description
batchId
string

The identifier of the batch.

customizedScript

Customized script properties for this on-demand batch execution.

dataDeliveryTimestamp
integer

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

executionId
string

The identifier of the execution.

executionStage
string

Execution stage.

  • DATA_RETRIEVED
  • EXECUTED
  • NOT_TRIGGERED
  • TIMED_OUT
  • TRIGGERED
  • WAITING
executionTimestamp
integer

The timestamp when execution was finished, in UTC milliseconds.

The ObjectNode object

Customized script properties for this on-demand batch execution.

The ExecutionFullResults object

Contains extended monitor's execution details.

Element
Type
Description
errorCode
string

Error code.

executionStepCount
integer

Number executed steps.

executionSteps

Details about the monitor's step execution.

failedStepName
string

Failed step name.

failedStepSequenceId
integer

Failed step sequence id.

failureMessage
string

Failure message.

The ExecutionStep object

Contains detailed information about the monitor's step execution.

Element
Type
Description
monitorType
string

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.

Element
Type
Description
chromeError
boolean

Informs whether is Chrome error.

engineId
integer

Synthetic engine id on which monitor was executed.

errorCode
string

Error code.

executedSteps
integer

Number of the executed steps by Synthetic engine

failureMessage
string

Failure message.

hostNameResolutionTime
integer

A hostname resolution 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