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. This is a base object, the exact type depends on the value of the type field.

Element Type Description Required
entityId string

The entity ID of the monitor.

required
name string

The name of the monitor.

required
frequencyMin integer

The frequency of the monitor, in minutes.

You can use one of the following values: 5, 10, 15, 30, and 60.

required
enabled boolean

The monitor is enabled (true) or disabled (false).

required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • BROWSER -> BrowserSyntheticMonitor
  • HTTP -> HttpSyntheticMonitor
required
createdFrom string

The origin of a monitor

required
script object

The script of a browser or HTTP monitor.

required
locations string[]

A list of locations from which the monitor is executed.

To specify a location, use its entity ID.

required
anomalyDetection AnomalyDetection optional
tags TagWithSourceInfo[]

A set of tags assigned to the monitor.

required
managementZones ManagementZoneDto[]

A set of management zones to which the monitor belongs to.

required
automaticallyAssignedApps string[]

A set of automatically assigned applications.

required
manuallyAssignedApps string[]

A set of manually assigned applications.

required
keyPerformanceMetrics KeyPerformanceMetrics optional
events EventDto[]

A list of events for this monitor

optional

The EventDto object

Element Type Description Required
entityId string

Event identifier

required
name string

Event name

required
sequenceNumber integer

Event sequence number

required

The KeyPerformanceMetrics object

The key performance metrics configuration.

Element Type Description Required
loadActionKpm string

Defines the key performance metric for load actions.

required
xhrActionKpm string

Defines the key performance metric for XHR actions.

required

The ManagementZoneDto object

Element Type Description Required
id string

Tne ID of the management zone.

required
name string

The name of the management zone.

required

The TagWithSourceInfo object

Tag with source of a Dynatrace entity.

Element Type Description Required
source string

The source of the tag, such as USER, RULE_BASED or AUTO

optional
context string

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

required
key string

The key of the tag.

Custom tags have the tag value here.

required
value string

The value of the tag.

Not applicable to custom tags.

optional

The AnomalyDetection object

The anomaly detection configuration.

Element Type Description Required
outageHandling OutageHandlingPolicy optional
loadingTimeThresholds LoadingTimeThresholdsPolicyDto optional

The LoadingTimeThresholdsPolicyDto object

Performance thresholds configuration.

Element Type Description Required
enabled boolean

Performance threshold is enabled (true) or disabled (false).

required
thresholds LoadingTimeThreshold[]

The list of performance threshold rules.

optional

The LoadingTimeThreshold object

The performance threshold rule.

Element Type Description Required
type string

The type of the threshold: total loading time or action loading time.

required
valueMs integer

Notify if monitor takes longer than X milliseconds to load.

required
requestIndex integer

Specify the request to which an ACTION threshold applies.

optional
eventIndex integer

Specify the event to which an ACTION threshold applies.

optional

The OutageHandlingPolicy object

Outage handling configuration.

Element Type Description Required
globalOutage boolean

When enabled (true), generate a problem and send an alert when the monitor is unavailable at all configured locations.

required
localOutage boolean

When enabled (true), generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.

required
localOutagePolicy LocalOutagePolicy required
retryOnError boolean

Schedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored.

optional

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 Required
affectedLocations integer

The number of affected locations to trigger an alert.

required
consecutiveRuns integer

The number of consecutive fails to trigger an alert.

required

HTTP

The HttpSyntheticMonitor object

The synthetic monitor. This is a base object, the exact type depends on the value of the type field.

Element Type Description Required
entityId string

The entity ID of the monitor.

required
name string

The name of the monitor.

required
frequencyMin integer

The frequency of the monitor, in minutes.

You can use one of the following values: 5, 10, 15, 30, and 60.

required
enabled boolean

The monitor is enabled (true) or disabled (false).

required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • BROWSER -> BrowserSyntheticMonitor
  • HTTP -> HttpSyntheticMonitor
required
createdFrom string

The origin of a monitor

required
script object

The script of a browser or HTTP monitor.

required
locations string[]

A list of locations from which the monitor is executed.

To specify a location, use its entity ID.

required
anomalyDetection AnomalyDetection optional
tags TagWithSourceInfo[]

A set of tags assigned to the monitor.

required
managementZones ManagementZoneDto[]

A set of management zones to which the monitor belongs to.

required
automaticallyAssignedApps string[]

A set of automatically assigned applications.

required
manuallyAssignedApps string[]

A set of manually assigned applications.

required
requests RequestDto[]

A list of events for this monitor

optional

The RequestDto object

Element Type Description Required
entityId string

Request identifier

required
name string

Request name

required
sequenceNumber integer

Request sequence number

required

The ManagementZoneDto object

Element Type Description Required
id string

Tne ID of the management zone.

required
name string

The name of the management zone.

required

The TagWithSourceInfo object

Tag with source of a Dynatrace entity.

Element Type Description Required
source string

The source of the tag, such as USER, RULE_BASED or AUTO

optional
context string

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

required
key string

The key of the tag.

Custom tags have the tag value here.

required
value string

The value of the tag.

Not applicable to custom tags.

optional

The AnomalyDetection object

The anomaly detection configuration.

Element Type Description Required
outageHandling OutageHandlingPolicy optional
loadingTimeThresholds LoadingTimeThresholdsPolicyDto optional

The LoadingTimeThresholdsPolicyDto object

Performance thresholds configuration.

Element Type Description Required
enabled boolean

Performance threshold is enabled (true) or disabled (false).

required
thresholds LoadingTimeThreshold[]

The list of performance threshold rules.

optional

The LoadingTimeThreshold object

The performance threshold rule.

Element Type Description Required
type string

The type of the threshold: total loading time or action loading time.

required
valueMs integer

Notify if monitor takes longer than X milliseconds to load.

required
requestIndex integer

Specify the request to which an ACTION threshold applies.

optional
eventIndex integer

Specify the event to which an ACTION threshold applies.

optional

The OutageHandlingPolicy object

Outage handling configuration.

Element Type Description Required
globalOutage boolean

When enabled (true), generate a problem and send an alert when the monitor is unavailable at all configured locations.

required
localOutage boolean

When enabled (true), generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.

required
localOutagePolicy LocalOutagePolicy required
retryOnError boolean

Schedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored.

optional

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 Required
affectedLocations integer

The number of affected locations to trigger an alert.

required
consecutiveRuns integer

The number of consecutive fails to trigger an alert.

required

Variations of the SyntheticMonitorUpdate object

BROWSER

The BrowserSyntheticMonitorUpdate object

The synthetic monitor update. This is a base object, the exact type depends on the value of the type field.

Element Type Description Required
frequencyMin integer

The frequency of the monitor, in minutes.

You can use one of the following values: 5, 10, 15, 30, and 60.

required
anomalyDetection AnomalyDetection optional
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • BROWSER -> BrowserSyntheticMonitorUpdate
  • HTTP -> HttpSyntheticMonitorUpdate
required
name string

The name of the monitor.

required
locations string[]

A list of locations from which the monitor is executed.

To specify a location, use its entity ID.

required
enabled boolean

The monitor is enabled (true) or disabled (false).

required
script object

The script of a browser or HTTP monitor.

required
tags TagWithSourceInfo[]

A set of tags assigned to the monitor.

You can specify only the value of the tag here and the CONTEXTLESS context and source 'USER' will be added automatically. But preferred option is usage of TagWithSourceDto model.

required
manuallyAssignedApps string[]

A set of manually assigned applications.

required
keyPerformanceMetrics KeyPerformanceMetrics required

The KeyPerformanceMetrics object

The key performance metrics configuration.

Element Type Description Required
loadActionKpm string

Defines the key performance metric for load actions.

required
xhrActionKpm string

Defines the key performance metric for XHR actions.

required

The TagWithSourceInfo object

Tag with source of a Dynatrace entity.

Element Type Description Required
source string

The source of the tag, such as USER, RULE_BASED or AUTO

optional
context string

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

required
key string

The key of the tag.

Custom tags have the tag value here.

required
value string

The value of the tag.

Not applicable to custom tags.

optional

The AnomalyDetection object

The anomaly detection configuration.

Element Type Description Required
outageHandling OutageHandlingPolicy optional
loadingTimeThresholds LoadingTimeThresholdsPolicyDto optional

The LoadingTimeThresholdsPolicyDto object

Performance thresholds configuration.

Element Type Description Required
enabled boolean

Performance threshold is enabled (true) or disabled (false).

required
thresholds LoadingTimeThreshold[]

The list of performance threshold rules.

optional

The LoadingTimeThreshold object

The performance threshold rule.

Element Type Description Required
type string

The type of the threshold: total loading time or action loading time.

required
valueMs integer

Notify if monitor takes longer than X milliseconds to load.

required
requestIndex integer

Specify the request to which an ACTION threshold applies.

optional
eventIndex integer

Specify the event to which an ACTION threshold applies.

optional

The OutageHandlingPolicy object

Outage handling configuration.

Element Type Description Required
globalOutage boolean

When enabled (true), generate a problem and send an alert when the monitor is unavailable at all configured locations.

required
localOutage boolean

When enabled (true), generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.

required
localOutagePolicy LocalOutagePolicy required
retryOnError boolean

Schedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored.

optional

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 Required
affectedLocations integer

The number of affected locations to trigger an alert.

required
consecutiveRuns integer

The number of consecutive fails to trigger an alert.

required

HTTP

The HttpSyntheticMonitorUpdate object

The synthetic monitor update. This is a base object, the exact type depends on the value of the type field.

Element Type Description Required
frequencyMin integer

The frequency of the monitor, in minutes.

You can use one of the following values: 5, 10, 15, 30, and 60.

required
anomalyDetection AnomalyDetection optional
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • BROWSER -> BrowserSyntheticMonitorUpdate
  • HTTP -> HttpSyntheticMonitorUpdate
required
name string

The name of the monitor.

required
locations string[]

A list of locations from which the monitor is executed.

To specify a location, use its entity ID.

required
enabled boolean

The monitor is enabled (true) or disabled (false).

required
script object

The script of a browser or HTTP monitor.

required
tags TagWithSourceInfo[]

A set of tags assigned to the monitor.

You can specify only the value of the tag here and the CONTEXTLESS context and source 'USER' will be added automatically. But preferred option is usage of TagWithSourceDto model.

required
manuallyAssignedApps string[]

A set of manually assigned applications.

required

The TagWithSourceInfo object

Tag with source of a Dynatrace entity.

Element Type Description Required
source string

The source of the tag, such as USER, RULE_BASED or AUTO

optional
context string

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

required
key string

The key of the tag.

Custom tags have the tag value here.

required
value string

The value of the tag.

Not applicable to custom tags.

optional

The AnomalyDetection object

The anomaly detection configuration.

Element Type Description Required
outageHandling OutageHandlingPolicy optional
loadingTimeThresholds LoadingTimeThresholdsPolicyDto optional

The LoadingTimeThresholdsPolicyDto object

Performance thresholds configuration.

Element Type Description Required
enabled boolean

Performance threshold is enabled (true) or disabled (false).

required
thresholds LoadingTimeThreshold[]

The list of performance threshold rules.

optional

The LoadingTimeThreshold object

The performance threshold rule.

Element Type Description Required
type string

The type of the threshold: total loading time or action loading time.

required
valueMs integer

Notify if monitor takes longer than X milliseconds to load.

required
requestIndex integer

Specify the request to which an ACTION threshold applies.

optional
eventIndex integer

Specify the event to which an ACTION threshold applies.

optional

The OutageHandlingPolicy object

Outage handling configuration.

Element Type Description Required
globalOutage boolean

When enabled (true), generate a problem and send an alert when the monitor is unavailable at all configured locations.

required
localOutage boolean

When enabled (true), generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.

required
localOutagePolicy LocalOutagePolicy required
retryOnError boolean

Schedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored.

optional

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 Required
affectedLocations integer

The number of affected locations to trigger an alert.

required
consecutiveRuns integer

The number of consecutive fails to trigger an alert.

required