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.
SyntheticMonitor objectBrowserSyntheticMonitor objectBrowser synthetic monitor. Some fields are inherited from the base SyntheticMonitor model.
| Element | Type | Description |
|---|---|---|
| events | Event | A list of events for this monitor |
| keyPerformanceMetrics | Key | The key performance metrics configuration. |
EventDto object| Element | Type | Description |
|---|---|---|
| entityId | string | Event identifier |
| name | string | Event name |
| sequenceNumber | integer | Event sequence number |
KeyPerformanceMetrics objectThe 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.
|
HttpSyntheticMonitor objectHTTP synthetic monitor. Some fields are inherited from base SyntheticMonitor model.
| Element | Type | Description |
|---|---|---|
| requests | Request | A list of events for this monitor |
RequestDto object| Element | Type | Description |
|---|---|---|
| entityId | string | Request identifier |
| name | string | Request name |
| sequenceNumber | integer | Request sequence number |
SyntheticMonitorUpdate objectBrowserSyntheticMonitorUpdate objectBrowser synthetic monitor update. Some fields are inherited from base SyntheticMonitorUpdate model.
| Element | Type | Description |
|---|---|---|
| keyPerformanceMetrics | Key | The key performance metrics configuration. |
KeyPerformanceMetrics objectThe 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.
|
HttpSyntheticMonitorUpdate objectHTTP synthetic monitor update. Some fields are inherited from base SyntheticMonitorUpdate model.
| Element | Type | Description |
|---|---|---|
| anomalyDetection | Anomaly | 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. For public locations use |
| 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 | Tag | 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:
|
AnomalyDetection objectThe anomaly detection configuration.
| Element | Type | Description |
|---|---|---|
| loadingTimeThresholds | Loading | Performance thresholds configuration. |
| outageHandling | Outage | Outage handling configuration. |
LoadingTimeThresholdsPolicyDto objectPerformance thresholds configuration.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | Performance threshold is enabled ( |
| thresholds | Loading | The list of performance threshold rules. |
LoadingTimeThreshold objectThe 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. |
OutageHandlingPolicy objectOutage handling configuration.
| Element | Type | Description |
|---|---|---|
| globalOutage | boolean | When enabled ( |
| globalOutagePolicy | Global | Global outage handling configuration. |
| localOutage | boolean | When enabled ( |
| localOutagePolicy | Local | 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. |
GlobalOutagePolicy objectGlobal outage handling configuration.
| Element | Type | Description |
|---|---|---|
| consecutiveRuns | integer | Alert if all locations are unable to access the web application X times consecutively. |
LocalOutagePolicy objectLocal 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. |
TagWithSourceInfo objectTag 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. |