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} |
Environment and Cluster ActiveGate (default port 9999) | https://{your-activegate-domain}:9999/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
The batch identifier of the executions.
Response
Response codes
Response body objects
The SyntheticOnDemandBatchStatus
object
Contains information about on-demand executions triggered within the batch.
The identifier of the batch.
The status of the batch.
FAILED
FAILED_TO_EXECUTE
NOT_TRIGGERED
RUNNING
SUCCESS
The number of triggered executions with the result SUCCESS or FAILED.
The number of triggered executions with the result FAILED.
The number of executions that were triggered and timed out because of a problem with the Synthetic engine.
String to string map of metadata properties for batch
The number of triggered executions within the batch.
The number of executions that were not triggered due to some problems.
The name of the user who triggered execution of the batch.
The SyntheticOnDemandFailedExecutionStatus
object
Contains information about on-demand executions that failed or failed to be executed.
Error code.
The identifier of the execution.
Execution stage.
DATA_RETRIEVED
EXECUTED
NOT_TRIGGERED
TIMED_OUT
TRIGGERED
WAITING
The timestamp when execution was finished, in UTC milliseconds.
Failure message.
The identifier of the location from where the monitor is to be executed.
The identifier of the monitor.
The SyntheticOnDemandTriggeringProblemDetails
object
Contains the details of problems encountered while triggering on-demand executions.
The cause of not triggering entity.
The details of triggering problem.
The entity identifier.
The execution identifier.
The location identifier.
Response body JSON model
{"batchId": "22396514015719218","batchStatus": "FAILED_TO_EXECUTE","executedCount": 1,"failedCount": 1,"failedExecutions": [{"errorCode": "CONSTRAINT_VIOLATED(3)","executionId": "1629891693487","executionStage": "EXECUTED","executionTimestamp": "1629891695487","failureMessage": "Validate text match failed","locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA","monitorId": "HTTP_CHECK-6349B98E1CD87352"}],"failedToExecute": [{"executionId": "478437504","executionStage": "TIMED_OUT","locationId": "SYNTHETIC_LOCATION-90380DA8A44C74BD","monitorId": "SYNTHETIC_TEST-027011D7D27CC892"}],"failedToExecuteCount": 1,"metadata": {"key": "value","version": "1.255.20221022"},"triggeredCount": 3,"triggeringProblems": [{"cause": "Location not found","entityId": "HTTP_CHECK-6349B98E1CD87352","locationId": "SYNTHETIC_LOCAT-9BB04DAEBA71B8CA"},{"cause": "Incorrect application identifier format","entityId": "APPLICATION-WRONG"}],"triggeringProblemsCount": 2,"userId": "admin"}