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 and Cluster ActiveGate (default port 9999)	`https://{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	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.
customizedScript	ObjectNode	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.
fullResults	ExecutionFullResults	Contains extended monitor's execution details.
locationId	string	The identifier of the location from where the monitor is to be executed.
metadata	object	Metadata map for the execution batch.
monitorId	string	The identifier of the monitor.
nextExecutionId	integer	Next execution id for sequential mode.
processingMode	string	The processing mode of the execution. `DISABLE_PROBLEM_DETECTION` `EXECUTIONS_DETAILS_ONLY` `NONE` `STANDARD` `UNKNOWN`
schedulingTimestamp	integer	The scheduling timestamp, in UTC milliseconds.
simpleResults	ExecutionSimpleResults	Contains basic results of the monitor's on-demand execution.
source	string	The source of the triggering request. `API` `UI`
userId	string	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.

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

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.
httperror	boolean	Informs whether is HTTP error.
~~peerCertificateExpiryDate~~	integer	DEPRECATED An expiry date of the first SSL certificate from the certificate chain.
publicLocation	boolean	Flag informs whether request was executed on public location.
redirectionTime	integer	Total number of milliseconds spent on handling all redirect requests, measured in milliseconds.
redirectsCount	integer	Number of redirects.
responseBodySizeLimitExceeded	boolean	A flag indicating that the response payload size limit of 10MB has been exceeded.
responseSize	integer	Request's response size in bytes.
responseStatusCode	integer	Response status code.
startTimestamp	integer	Start timestamp.
status	string	Execution status.
tcpConnectTime	integer	A TCP connect time measured in milliseconds.
timeToFirstByte	integer	A time to first byte measured in milliseconds.
tlsHandshakeTime	integer	A TLS handshake time measured in milliseconds.
totalTime	integer	A total time measured in milliseconds.

Response body JSON model

1{
2  "batchId": "22396514015719218",
3  "customizedScript": {
4    "requests": [
5      {
6        "sequenceId": "1",
7        "url": "https://www.somepage.org",
8        "validation": {
9          "rules": [
10            {
11              "passIfFound": "true",
12              "type": "httpStatusesList",
13              "value": "=201"
14            }
15          ]
16        }
17      }
18    ]
19  },
20  "dataDeliveryTimestamp": "1629891701171",
21  "executionId": "7002396514015719218",
22  "executionStage": "DATA_RETRIEVED",
23  "executionTimestamp": "1629891695487",
24  "locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA",
25  "metadata": {
26    "key": "value",
27    "version": "1.255.20221022"
28  },
29  "monitorId": "HTTP_CHECK-6349B98E1CD87352",
30  "processingMode": "STANDARD",
31  "schedulingTime": "1629891686877",
32  "simpleResults": [
33    {
34      "engineId": "1993198092",
35      "executedSteps": "1",
36      "healthStatus": "HEALTHY",
37      "hostNameResolutionTime": "50",
38      "publicLocation": "false",
39      "redirectionTime": "576",
40      "responseBodySizeLimitExceeded": "false",
41      "responseSize": "1530652",
42      "responseStatusCode": "200",
43      "startTimestamp": "1629891693487",
44      "tcpConnectTime": "127",
45      "tlsHandshakeTime": "167",
46      "totalTime": "955"
47    }
48  ],
49  "source": "API",
50  "userId": "someUserIdentifier"
51}

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

Authentication

Parameters

Response

Response codes

Response body objects

The SyntheticOnDemandExecution object

The ObjectNode object

The ExecutionFullResults object

The ExecutionStep object

The ExecutionSimpleResults object