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

Browser synthetic monitor. Some fields are inherited from the base SyntheticMonitor model.

Element
Type
Description
events

A list of events for this monitor

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.

  • VISUALLY_COMPLETE
  • SPEED_INDEX
  • USER_ACTION_DURATION
  • TIME_TO_FIRST_BYTE
  • HTML_DOWNLOADED
  • DOM_INTERACTIVE
  • LOAD_EVENT_START
  • LOAD_EVENT_END
xhrActionKpm
string

Defines the key performance metric for XHR actions.

  • VISUALLY_COMPLETE
  • USER_ACTION_DURATION
  • TIME_TO_FIRST_BYTE
  • RESPONSE_END

HTTP

The HttpSyntheticMonitor object

HTTP synthetic monitor. Some fields are inherited from base SyntheticMonitor model.

Element
Type
Description
requests

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

Browser synthetic monitor update. Some fields are inherited from base SyntheticMonitorUpdate model.

Element
Type
Description
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.

  • VISUALLY_COMPLETE
  • SPEED_INDEX
  • USER_ACTION_DURATION
  • TIME_TO_FIRST_BYTE
  • HTML_DOWNLOADED
  • DOM_INTERACTIVE
  • LOAD_EVENT_START
  • LOAD_EVENT_END
xhrActionKpm
string

Defines the key performance metric for XHR actions.

  • VISUALLY_COMPLETE
  • USER_ACTION_DURATION
  • TIME_TO_FIRST_BYTE
  • RESPONSE_END

HTTP

The HttpSyntheticMonitorUpdate object

HTTP synthetic monitor update. Some fields are inherited from base SyntheticMonitorUpdate model.

Element
Type
Description
anomalyDetection

The anomaly detection configuration.

enabled
boolean

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

frequencyMin
integer

The frequency of the monitor, in minutes.

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

locations
string[]

A list of locations from which the monitor is executed.

To specify a location, use its entity ID. For public locations use GEOLOCATION-9999453BE4BDB3CD form and SYNTHETIC_LOCATION-DF80ACFB688C583B for private ones.

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

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.

type
string

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

  • BROWSER -> BrowserSyntheticMonitorUpdate
  • HTTP -> HttpSyntheticMonitorUpdate
  • BROWSER
  • HTTP

The AnomalyDetection object

The anomaly detection configuration.

Element
Type
Description
loadingTimeThresholds

Performance thresholds configuration.

outageHandling

Outage handling configuration.

The LoadingTimeThresholdsPolicyDto object

Performance thresholds configuration.

Element
Type
Description
enabled
boolean

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

thresholds

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.

  • ACTION
  • TOTAL
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 (true), generate a problem and send an alert when the monitor is unavailable at all configured locations.

globalOutagePolicy

Global outage handling configuration.

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.

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 CONTEXTLESS value.

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
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

  • AUTO
  • RULE_BASED
  • USER
value
string

The value of the tag.

Not applicable to custom tags.