Synthetic monitor executions API v2 - GET summary of a batch execution

Gets the summary of a batch execution 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/batch/{batchId}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/executions/batch/{batchId}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/executions/batch/{batchId}`

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
batchId	integer	The batch identifier of the executions.	path	required

Response

Response codes

Code	Type	Description
200	SyntheticOnDemandBatchStatus	Success

Response body objects

The `SyntheticOnDemandBatchStatus` object

Contains information about on-demand executions triggered within the batch.

Element	Type	Description
batchId	string	The identifier of the batch.
userId	string	The name of the user who triggered execution of the batch.
batchStatus	string	The status of the batch. The element can hold these values `FAILED` `FAILED_TO_EXECUTE` `NOT_TRIGGERED` `RUNNING` `SUCCESS`
triggeredCount	integer	The number of triggered executions within the batch.
executedCount	integer	The number of triggered executions with the result SUCCESS or FAILED.
failedCount	integer	The number of triggered executions with the result FAILED.
failedExecutions	SyntheticOnDemandFailedExecutionStatus[]	-
failedToExecuteCount	integer	The number of executions that were triggered and timed out because of a problem with the Synthetic engine.
failedToExecute	SyntheticOnDemandFailedExecutionStatus[]	-
metadata	object	String to string map of metadata properties for batch
triggeringProblemsCount	integer	The number of executions that were not triggered due to some problems.
triggeringProblems	SyntheticOnDemandTriggeringProblemDetails[]	-

The `SyntheticOnDemandFailedExecutionStatus` object

Contains information about on-demand executions that failed or failed to be executed.

Element	Type	Description
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`
failureMessage	string	Failure message.
errorCode	string	Error code.
executionTimestamp	integer	The timestamp when execution was finished, 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.

The `SyntheticOnDemandTriggeringProblemDetails` object

Contains the details of problems encountered while triggering on-demand executions.

Element	Type	Description
entityId	string	The entity identifier.
locationId	string	The location identifier.
cause	string	The cause of not triggering entity.

Response body JSON model

json
{
  "batchId": "22396514015719218",
  "userId": "admin",
  "batchStatus": "FAILED_TO_EXECUTE",
  "triggeredCount": 3,
  "executedCount": 1,
  "failedCount": 1,
  "failedExecutions": [
    {
      "executionId": "1629891693487",
      "executionStage": "EXECUTED",
      "failureMessage": "Validate text match failed",
      "errorCode": "CONSTRAINT_VIOLATED(3)",
      "executionTimestamp": "1629891695487",
      "monitorId": "HTTP_CHECK-6349B98E1CD87352",
      "locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA"
    }
  ],
  "failedToExecuteCount": 1,
  "failedToExecute": [
    {
      "executionId": "478437504",
      "executionStage": "TIMED_OUT",
      "monitorId": "SYNTHETIC_TEST-027011D7D27CC892",
      "locationId": "SYNTHETIC_LOCATION-90380DA8A44C74BD"
    }
  ],
  "triggeringProblemsCount": 2,
  "triggeringProblems": [
    {
      "entityId": "HTTP_CHECK-6349B98E1CD87352",
      "locationId": "SYNTHETIC_LOCAT-9BB04DAEBA71B8CA",
      "cause": "Location not found"
    },
    {
      "entityId": "APPLICATION-WRONG",
      "cause": "Incorrect application identifier format"
    }
  ],
  "metadata": {
    "key": "value",
    "version": "1.255.20221022"
  }
}