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 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
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. |
batchStatus | string | The status of 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[] | - |
failedToExecute | SyntheticOnDemandFailedExecutionStatus[] | - |
failedToExecuteCount | integer | The number of executions that were triggered and timed out because of a problem with the Synthetic engine. |
metadata | object | String to string map of metadata properties for batch |
triggeredCount | integer | The number of triggered executions within the batch. |
triggeringProblems | SyntheticOnDemandTriggeringProblemDetails[] | - |
triggeringProblemsCount | integer | The number of executions that were not triggered due to some problems. |
userId | string | 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.
Element | Type | Description |
---|---|---|
errorCode | string | Error code. |
executionId | string | The identifier of the execution. |
executionStage | string | Execution stage.
|
executionTimestamp | integer | The timestamp when execution was finished, in UTC milliseconds. |
failureMessage | string | Failure message. |
locationId | string | The identifier of the location from where the monitor is to be executed. |
monitorId | string | The identifier of the monitor. |
The SyntheticOnDemandTriggeringProblemDetails
object
Contains the details of problems encountered while triggering on-demand executions.
Element | Type | Description |
---|---|---|
cause | string | The cause of not triggering entity. |
details | string | The details of triggering problem. |
entityId | string | The entity identifier. |
locationId | string | The location identifier. |
Response body JSON model
1{2 "batchId": "22396514015719218",3 "batchStatus": "FAILED_TO_EXECUTE",4 "executedCount": 1,5 "failedCount": 1,6 "failedExecutions": [7 {8 "errorCode": "CONSTRAINT_VIOLATED(3)",9 "executionId": "1629891693487",10 "executionStage": "EXECUTED",11 "executionTimestamp": "1629891695487",12 "failureMessage": "Validate text match failed",13 "locationId": "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA",14 "monitorId": "HTTP_CHECK-6349B98E1CD87352"15 }16 ],17 "failedToExecute": [18 {19 "executionId": "478437504",20 "executionStage": "TIMED_OUT",21 "locationId": "SYNTHETIC_LOCATION-90380DA8A44C74BD",22 "monitorId": "SYNTHETIC_TEST-027011D7D27CC892"23 }24 ],25 "failedToExecuteCount": 1,26 "metadata": {27 "key": "value",28 "version": "1.255.20221022"29 },30 "triggeredCount": 3,31 "triggeringProblems": [32 {33 "cause": "Location not found",34 "entityId": "HTTP_CHECK-6349B98E1CD87352",35 "locationId": "SYNTHETIC_LOCAT-9BB04DAEBA71B8CA"36 },37 {38 "cause": "Incorrect application identifier format",39 "entityId": "APPLICATION-WRONG"40 }41 ],42 "triggeringProblemsCount": 2,43 "userId": "admin"44}