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.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/executions
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/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.

  • TRIGGERED
  • EXECUTED
  • DATA_RETRIEVED
query
optional
schedulingFrom
string

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).

query
optional
schedulingTo
string

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.

query
optional
executionFrom
string

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).

query
optional
executionTo
string

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.

query
optional
dataDeliveryFrom
string

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).

query
optional

Response

Response codes

Code
Type
Description
200

Success

400

Failed. The input is invalid.

4XX

Client side error.

5XX

Server side error.

Response body objects

The SyntheticOnDemandExecutions object

Contains a list of synthetic on-demand executions.

Element
Type
Description
executions

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

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

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

Related topics