Synthetic monitor executions API v2 - GET all on-demand executions
Gets a list of all all on-demand executions of synthetic monitors.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/executions |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/executions | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/executions |
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 |
---|---|---|---|---|
executionStage | string | Filters the resulting set of executions by their stage. | query | optional |
schedulingFrom | string | The start of the requested timeframe for scheduling timestamps. You can use one of the following formats:
If not set, the maximum relative timeframe of six hours is used ( | query | optional |
schedulingTo | string | The end of the requested timeframe for scheduling timestamps. You can use one of the following formats:
If not set, the current timestamp is used. | query | optional |
executionFrom | string | The start of the requested timeframe for execution timestamps. You can use one of the following formats:
If not set, the maximum relative timeframe of six hours is used ( | query | optional |
executionTo | string | The end of the requested timeframe for execution timestamps. You can use one of the following formats:
If not set, the current timestamp is used. | query | optional |
dataDeliveryFrom | string | The start of the requested timeframe for data delivering timestamps. You can use one of the following formats:
If not set, the maximum relative timeframe of six hours is used ( | query | optional |
dataDeliveryTo | string | The end of the requested timeframe for data delivering timestamps. You can use one of the following formats:
If not set, the current timestamp is used. | query | optional |
batchId | integer | Filters the resulting set of the executions by batch. Specify the ID of the batch. | query | optional |
monitorId | string | Filters the resulting set of the executions by monitor synthetic monitor. Specify the ID of the monitor. | query | optional |
locationId | string | Filters the resulting set of the executions by Synthetic location. Specify the ID of the location. | query | optional |
userId | string | Filters the resulting set of executions by scheduled user. | query | optional |
source | string | Filters the resulting set of the executions by the source of the triggering request. | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Synthetic | Success |
Response body objects
The SyntheticOnDemandExecutions
object
Contains a list of synthetic on-demand executions.
Element | Type | Description |
---|---|---|
executions | Synthetic | The list of executions. |
The SyntheticOnDemandExecution
object
Describes the status of an on-demand execution.
Element | Type | Description |
---|---|---|
batchId | string | The identifier of the batch. |
customizedScript | Object | 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. |
executionTimestamp | integer | The timestamp when execution was finished, in UTC milliseconds. |
fullResults | Execution | 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. |
schedulingTimestamp | integer | The scheduling timestamp, in UTC milliseconds. |
simpleResults | Execution | Contains basic results of the monitor's on-demand execution. |
source | string | The source of the triggering request. |
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 object doesn't provide any parameters.
The ExecutionFullResults
object
Contains extended monitor's execution details.
Element | Type | Description |
---|---|---|
errorCode | string | Error code. |
executionStepCount | integer | Number executed steps. |
executionSteps | Execution | 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:
|
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. |
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
{
"executions": [
{
"executionId": "7002396514015719218",
"executionStage": "EXECUTED",
"executionTimestamp": "1629891695487",
"locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA",
"monitorId": "HTTP_CHECK-6349B98E1CD87352",
"schedulingTimestamp": "1629891686877",
"userId": "someUserIdentifier"
}
]
}