Synthetic monitors API - JSON models
Some JSON models of the Synthetic monitors API vary depending on the type of the model. The JSON models for each variation are listed below.
Variations of the SyntheticMonitor object
BROWSER
The BrowserSyntheticMonitor object
The synthetic monitor.
The actual set of fields depends the type of the monitor. Find the list of actual objects in the description of the type field or see Synthetic monitors API - JSON models.
| Element | Type | Description |
|---|---|---|
| events | EventDto[] | A list of events for this monitor |
| keyPerformanceMetrics | KeyPerformanceMetrics | The key performance metrics configuration. |
The EventDto object
| Element | Type | Description |
|---|---|---|
| entityId | string | Event identifier |
| name | string | Event name |
| sequenceNumber | integer | Event sequence number |
The KeyPerformanceMetrics object
The key performance metrics configuration.
| Element | Type | Description |
|---|---|---|
| loadActionKpm | string | Defines the key performance metric for load actions.
|
| xhrActionKpm | string | Defines the key performance metric for XHR actions.
|
HTTP
The HttpSyntheticMonitor object
The synthetic monitor.
The actual set of fields depends the type of the monitor. Find the list of actual objects in the description of the type field or see Synthetic monitors API - JSON models.
| Element | Type | Description |
|---|---|---|
| requests | RequestDto[] | A list of events for this monitor |
The RequestDto object
| Element | Type | Description |
|---|---|---|
| entityId | string | Request identifier |
| name | string | Request name |
| sequenceNumber | integer | Request sequence number |
Variations of the SyntheticMonitorUpdate object
BROWSER
The BrowserSyntheticMonitorUpdate object
The synthetic monitor update.
The actual set of fields depends the type of the monitor. Find the list of actual objects in the description of the type field or see Synthetic monitors API - JSON models.
| Element | Type | Description |
|---|---|---|
| keyPerformanceMetrics | KeyPerformanceMetrics | The key performance metrics configuration. |
The KeyPerformanceMetrics object
The key performance metrics configuration.
| Element | Type | Description |
|---|---|---|
| loadActionKpm | string | Defines the key performance metric for load actions.
|
| xhrActionKpm | string | Defines the key performance metric for XHR actions.
|
HTTP
The HttpSyntheticMonitorUpdate object
The synthetic monitor update.
The actual set of fields depends the type of the monitor. Find the list of actual objects in the description of the type field or see Synthetic monitors API - JSON models.
| Element | Type | Description |
|---|---|---|
| anomalyDetection | AnomalyDetection | The anomaly detection configuration. |
| enabled | boolean | The monitor is enabled ( |
| frequencyMin | integer | The frequency of the monitor, in minutes. You can use one of the following values: |
| locations | string[] | A list of locations from which the monitor is executed. To specify a location, use its entity ID. |
| manuallyAssignedApps | string[] | A set of manually assigned applications. |
| name | string | The name of the monitor. |
| script | object | The script of a browser or HTTP monitor. |
| tags | TagWithSourceInfo[] | A set of tags assigned to the monitor. You can specify only the value of the tag here and the |
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
The AnomalyDetection object
The anomaly detection configuration.
| Element | Type | Description |
|---|---|---|
| loadingTimeThresholds | LoadingTimeThresholdsPolicyDto | Performance thresholds configuration. |
| outageHandling | OutageHandlingPolicy | Outage handling configuration. |
The LoadingTimeThresholdsPolicyDto object
Performance thresholds configuration.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | Performance threshold is enabled ( |
| thresholds | LoadingTimeThreshold[] | The list of performance threshold rules. |
The LoadingTimeThreshold object
The performance threshold rule.
| Element | Type | Description |
|---|---|---|
| eventIndex | integer | Specify the event to which an ACTION threshold applies. |
| requestIndex | integer | Specify the request to which an ACTION threshold applies. |
| type | string | The type of the threshold: total loading time or action loading time.
|
| valueMs | integer | Notify if monitor takes longer than X milliseconds to load. |
The OutageHandlingPolicy object
Outage handling configuration.
| Element | Type | Description |
|---|---|---|
| globalOutage | boolean | When enabled ( |
| globalOutagePolicy | GlobalOutagePolicy | Global outage handling configuration. |
| localOutage | boolean | When enabled ( |
| localOutagePolicy | LocalOutagePolicy | Local outage handling configuration. Alert if affectedLocations of locations are unable to access the web application consecutiveRuns times consecutively. |
| retryOnError | boolean | Schedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored. |
The GlobalOutagePolicy object
Global outage handling configuration.
| Element | Type | Description |
|---|---|---|
| consecutiveRuns | integer | Alert if all locations are unable to access the web application X times consecutively. |
The LocalOutagePolicy object
Local outage handling configuration.
Alert if affectedLocations of locations are unable to access the web application consecutiveRuns times consecutively.
| Element | Type | Description |
|---|---|---|
| affectedLocations | integer | The number of affected locations to trigger an alert. |
| consecutiveRuns | integer | The number of consecutive fails to trigger an alert. |
The TagWithSourceInfo object
Tag with source of a Dynatrace entity.
| Element | Type | Description |
|---|---|---|
| context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the
|
| key | string | The key of the tag. Custom tags have the tag value here. |
| source | string | The source of the tag, such as USER, RULE_BASED or AUTO
|
| value | string | The value of the tag. Not applicable to custom tags. |