• Home
  • Dynatrace API
  • Environment
  • Synthetic v2
  • Monitor executions
  • GET all on-demand executions

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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/synthetic/executions
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/executions
Environment ActiveGatehttps://{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

ParameterTypeDescriptionInRequired
executionStagestring

Filters the resulting set of executions by their stage.

The element can hold these values
  • TRIGGERED
  • EXECUTED
  • DATA_RETRIEVED
queryoptional
schedulingFromstring

The start of the requested timeframe for scheduling timestamps.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.
  • Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are:
    • m: minutes
    • h: hours
    • d: days
    • w: weeks
    • M: months
    • y: years

If not set, the maximum relative timeframe of six hours is used (now-6h).

queryoptional
schedulingTostring

The end of the requested timeframe for scheduling timestamps.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.
  • Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are:
    • m: minutes
    • h: hours
    • d: days
    • w: weeks
    • M: months
    • y: years

If not set, the current timestamp is used.

queryoptional
executionFromstring

The start of the requested timeframe for execution timestamps.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.
  • Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are:
    • m: minutes
    • h: hours
    • d: days
    • w: weeks
    • M: months
    • y: years

If not set, the maximum relative timeframe of six hours is used (now-6h).

queryoptional
executionTostring

The end of the requested timeframe for execution timestamps.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.
  • Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are:
    • m: minutes
    • h: hours
    • d: days
    • w: weeks
    • M: months
    • y: years

If not set, the current timestamp is used.

queryoptional
dataDeliveryFromstring

The start of the requested timeframe for data delivering timestamps.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.
  • Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are:
    • m: minutes
    • h: hours
    • d: days
    • w: weeks
    • M: months
    • y: years

If not set, the maximum relative timeframe of six hours is used (now-6h).

queryoptional
dataDeliveryTostring

The end of the requested timeframe for data delivering timestamps.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.
  • Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are:
    • m: minutes
    • h: hours
    • d: days
    • w: weeks
    • M: months
    • y: years

If not set, the current timestamp is used.

queryoptional
batchIdinteger

Filters the resulting set of the executions by batch. Specify the ID of the batch.

queryoptional
monitorIdstring

Filters the resulting set of the executions by monitor synthetic monitor. Specify the ID of the monitor.

queryoptional
locationIdstring

Filters the resulting set of the executions by Synthetic location. Specify the ID of the location.

queryoptional
userIdstring

Filters the resulting set of executions by scheduled user.

queryoptional
sourcestring

Filters the resulting set of the executions by the source of the triggering request.

The element can hold these values
  • API
  • UI
queryoptional

Response

Response codes

CodeTypeDescription
200SyntheticOnDemandExecutions

Success

Response body objects

The SyntheticOnDemandExecutions object

Contains a list of synthetic on-demand executions.

ElementTypeDescription
executionsSyntheticOnDemandExecution[]

The list of executions.

The SyntheticOnDemandExecution object

Describes the status of an on-demand execution.

ElementTypeDescription
batchIdstring

The identifier of the batch.

executionIdstring

The identifier of the execution.

executionStagestring

Execution stage.

The element can hold these values
  • DATA_RETRIEVED
  • EXECUTED
  • NOT_TRIGGERED
  • TIMED_OUT
  • TRIGGERED
  • WAITING
schedulingTimestampinteger

The scheduling timestamp, in UTC milliseconds.

executionTimestampinteger

The timestamp when execution was finished, in UTC milliseconds.

dataDeliveryTimestampinteger

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

monitorIdstring

The identifier of the monitor.

locationIdstring

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

nextExecutionIdinteger

Next execution id for sequential mode.

userIdstring

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

metadataobject

Metadata map for the execution batch.

sourcestring

The source of the triggering request.

The element can hold these values
  • API
  • UI
processingModestring

The processing mode of the execution.

The element can hold these values
  • DISABLE_PROBLEM_DETECTION
  • EXECUTIONS_DETAILS_ONLY
  • NONE
  • STANDARD
  • UNKNOWN
customizedScriptObjectNode

Customized script properties for this on-demand batch execution.

simpleResultsExecutionSimpleResults

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

fullResultsExecutionFullResults

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.

ElementTypeDescription
statusstring

Execution status.

failureMessagestring

Failure message.

errorCodestring

Error code.

responseStatusCodeinteger

Response status code.

executedStepsinteger

Number of the executed steps by Synthetic engine

engineIdinteger

Synthetic engine id on which monitor was executed.

httperrorboolean

Informs whether is HTTP error.

chromeErrorboolean

Informs whether is Chrome error.

publicLocationboolean

Flag informs whether request was executed on public location.

responseSizeinteger

Request's response size in bytes.

responseBodySizeLimitExceededboolean

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

peerCertificateExpiryDateinteger

DEPRECATED

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

totalTimeinteger

A total time measured in milliseconds.

hostNameResolutionTimeinteger

A hostname resolution time measured in milliseconds.

tcpConnectTimeinteger

A TCP connect time measured in milliseconds.

tlsHandshakeTimeinteger

A TLS handshake time measured in milliseconds.

timeToFirstByteinteger

A time to first byte measured in milliseconds.

redirectionTimeinteger

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

redirectsCountinteger

Number of redirects.

startTimestampinteger

Start timestamp.

The ExecutionFullResults object

Contains extended monitor's execution details.

ElementTypeDescription
statusstring

Execution status.

failureMessagestring

Failure message.

errorCodestring

Error code.

executionStepCountinteger

Number executed steps.

executionStepsExecutionStep[]

Details about the monitor's step execution.

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

Response body JSON model

json
{ "executions": [ { "executionId": "7002396514015719218", "schedulingTimestamp": "1629891686877", "executionTimestamp": "1629891695487", "monitorId": "HTTP_CHECK-6349B98E1CD87352", "locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA", "executionStage": "EXECUTED", "userId": "someUserIdentifier" } ] }
Related topics
  • Synthetic Monitoring

    Learn about Synthetic Monitoring and how to create a single-URL browser monitor, a browser clickpath, or an HTTP monitor.