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.

GET	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/executions/{executionId}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/executions/{executionId}`
	Environment ActiveGate	`https://{your-activegate-domain}/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	SyntheticOnDemandExecution	Success. The response contains basic information about the on-demand execution.

Response body objects

The `SyntheticOnDemandExecution` object

Describes the status of an on-demand execution.

Element	Type	Description
batchId	string	The identifier of the batch.
executionId	string	The identifier of the execution.
executionStage	string	Execution stage. The element can hold these values `DATA_RETRIEVED` `EXECUTED` `NOT_TRIGGERED` `TIMED_OUT` `TRIGGERED` `WAITING`
schedulingTimestamp	integer	The scheduling timestamp, in UTC milliseconds.
executionTimestamp	integer	The timestamp when execution was finished, in UTC milliseconds.
dataDeliveryTimestamp	integer	The timestamp when whole data set has been collected on server, in UTC milliseconds.
monitorId	string	The identifier of the monitor.
locationId	string	The identifier of the location from where the monitor is to be executed.
nextExecutionId	integer	Next execution id for sequential mode.
userId	string	The name of the user who triggered the on-demand execution.
metadata	object	Metadata map for the execution batch.
source	string	The source of the triggering request. The element can hold these values `API` `UI`
processingMode	string	The processing mode of the execution. The element can hold these values `DISABLE_PROBLEM_DETECTION` `EXECUTIONS_DETAILS_ONLY` `NONE` `STANDARD` `UNKNOWN`
customizedScript	ObjectNode	Customized script properties for this on-demand batch execution.
simpleResults	ExecutionSimpleResults	Contains basic results of the monitor's on-demand execution.
fullResults	ExecutionFullResults	Contains extended monitor's execution details.

The `ObjectNode` object

Customized script properties for this on-demand batch execution.

The object doesn't provide any parameters.

The `ExecutionSimpleResults` object

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

Element	Type	Description
status	string	Execution status.
failureMessage	string	Failure message.
errorCode	string	Error code.
responseStatusCode	integer	Response status code.
executedSteps	integer	Number of the executed steps by Synthetic engine
engineId	integer	Synthetic engine id on which monitor was executed.
httperror	boolean	Informs whether is HTTP error.
chromeError	boolean	Informs whether is Chrome error.
publicLocation	boolean	Flag informs whether request was executed on public location.
responseSize	integer	Request's response size in bytes.
responseBodySizeLimitExceeded	boolean	A flag indicating that the response payload size limit of 10MB has been exceeded.
~~peerCertificateExpiryDate~~	integer	DEPRECATED An expiry date of the first SSL certificate from the certificate chain.
totalTime	integer	A total time measured in milliseconds.
hostNameResolutionTime	integer	A hostname resolution time measured in milliseconds.
tcpConnectTime	integer	A TCP connect time measured in milliseconds.
tlsHandshakeTime	integer	A TLS handshake time measured in milliseconds.
timeToFirstByte	integer	A time to first byte measured in milliseconds.
redirectionTime	integer	Total number of milliseconds spent on handling all redirect requests, measured in milliseconds.
redirectsCount	integer	Number of redirects.
startTimestamp	integer	Start timestamp.

The `ExecutionFullResults` object

Contains extended monitor's execution details.

Element	Type	Description
status	string	Execution status.
failureMessage	string	Failure message.
errorCode	string	Error code.
executionStepCount	integer	Number executed steps.
executionSteps	ExecutionStep[]	Details about the monitor's step execution.

The `ExecutionStep` object

Contains detailed information about the monitor's step execution.

Element Type Description

monitorType

string

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 The element can hold these values `BROWSER` `HTTP`

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

BROWSER -> BMAction
HTTP -> MonitorRequestExecutionResult

The element can hold these values

BROWSER
HTTP

Response body JSON model

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