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.
EventDto objectEvent identifier
Event name
Event sequence number
KeyPerformanceMetrics objectThe key performance metrics configuration.
Defines the key performance metric for load actions.
VISUALLY_COMPLETESPEED_INDEXUSER_ACTION_DURATIONTIME_TO_FIRST_BYTEHTML_DOWNLOADEDDOM_INTERACTIVELOAD_EVENT_STARTLOAD_EVENT_ENDDefines the key performance metric for XHR actions.
VISUALLY_COMPLETEUSER_ACTION_DURATIONTIME_TO_FIRST_BYTERESPONSE_END{"entityId": "SYNTHETIC_TEST-790745B687BE4D0E","name": "Browser monitor","frequencyMin": 10,"enabled": true,"type": "BROWSER","createdFrom": "GUI","script": {"type": "clickpath","version": "1.0","configuration": {"device": {"mobile": false,"touchEnabled": false,"width": 1024,"height": 768,"scaleFactor": 1}},"events": [{"type": "navigate","description": "Loading of \"https://orf.at\"","url": "https://orf.at","wait": {"waitFor": "page_complete"}}]},"locations": ["GEOLOCATION-0A41430434C388A9"],"anomalyDetection": {"outageHandling": {"globalOutage": true,"localOutage": false,"localOutagePolicy": {"affectedLocations": 1,"consecutiveRuns": 3}},"loadingTimeThresholds": {"enabled": true,"thresholds": [{"type": "TOTAL","valueMs": 10000}]}},"tags": [{"context": "CONTEXTLESS","key": "blabla"}],"managementZones": [{"id": "-7832237287622819191","name": "!!allSynthetic"}],"automaticallyAssignedApps": ["APPLICATION-7ADA0EF404C7C545"],"manuallyAssignedApps": ["APPLICATION-4ADF0EF407C7C545"],"keyPerformanceMetrics": {"loadActionKpm": "VISUALLY_COMPLETE","xhrActionKpm": "VISUALLY_COMPLETE"},"events": [{"entityId": "SYNTHETIC_TEST_STEP-2E6FDA5B4BC39A27","name": "Loading of \"https://orf.at\"","sequenceNumber": 1}]}
HttpSyntheticMonitor objectHTTP synthetic monitor. Some fields are inherited from base SyntheticMonitor model.
RequestDto objectRequest identifier
Request name
Request sequence number
{"entityId": "HTTP_CHECK-B58DA1B8B892A05C","name": "HTTP monitor","frequencyMin": 1,"enabled": true,"type": "HTTP","createdFrom": "GUI","script": {"version": "1.0","requests": [{"description": "orf.at","url": "https://orf.at","method": "GET","requestBody": "","configuration": {"acceptAnyCertificate": true,"followRedirects": true},"preProcessingScript": "","postProcessingScript": ""}]},"locations": ["SYNTHETIC_LOCATION-61F43EECF5FB8345"],"anomalyDetection": {"outageHandling": {"globalOutage": true,"localOutage": false,"localOutagePolicy": {"affectedLocations": 1,"consecutiveRuns": 3}},"loadingTimeThresholds": {"enabled": false,"thresholds": [{"type": "TOTAL","valueMs": 10000}]}},"tags": [],"managementZones": [{"id": "-7832237287622819191","name": "!!allSynthetic"}],"automaticallyAssignedApps": ["APPLICATION-4ADF0EF407C7C545"],"manuallyAssignedApps": ["APPLICATION-7ADA0EF404C7C545"],"requests": [{"entityId": "HTTP_CHECK_STEP-E9208469D53BAF38","name": "orf.at","sequenceNumber": 1}]}
SyntheticMonitorUpdate objectBrowserSyntheticMonitorUpdate objectBrowser synthetic monitor update. Some fields are inherited from base SyntheticMonitorUpdate model.
KeyPerformanceMetrics objectThe key performance metrics configuration.
Defines the key performance metric for load actions.
VISUALLY_COMPLETESPEED_INDEXUSER_ACTION_DURATIONTIME_TO_FIRST_BYTEHTML_DOWNLOADEDDOM_INTERACTIVELOAD_EVENT_STARTLOAD_EVENT_ENDDefines the key performance metric for XHR actions.
VISUALLY_COMPLETEUSER_ACTION_DURATIONTIME_TO_FIRST_BYTERESPONSE_END{"name": "Browser monitor","frequencyMin": 10,"enabled": true,"type": "BROWSER","script": {"type": "clickpath","version": "1.0","configuration": {"device": {"mobile": false,"touchEnabled": false,"width": 1024,"height": 768,"scaleFactor": 1}},"events": [{"type": "navigate","description": "Loading of \"https://orf.at\"","url": "https://orf.at","wait": {"waitFor": "page_complete"}}]},"locations": ["GEOLOCATION-0A41430434C388A9"],"anomalyDetection": {"outageHandling": {"globalOutage": true,"localOutage": false,"localOutagePolicy": {"affectedLocations": 1,"consecutiveRuns": 3}},"loadingTimeThresholds": {"enabled": true,"thresholds": [{"type": "TOTAL","valueMs": 10000}]}},"tags": [{"context": "CONTEXTLESS","key": "blabla"}],"manuallyAssignedApps": ["APPLICATION-4ADF0EF407C7C545"],"keyPerformanceMetrics": {"loadActionKpm": "VISUALLY_COMPLETE","xhrActionKpm": "VISUALLY_COMPLETE"}}
HttpSyntheticMonitorUpdate objectHTTP synthetic monitor update. Some fields are inherited from base SyntheticMonitorUpdate model.
The monitor is enabled (true) or disabled (false).
The frequency of the monitor, in minutes.
You can use one of the following values: 5, 10, 15, 30, and 60.
A list of locations from which the monitor is executed.
To specify a location, use its entity ID.
A set of manually assigned applications.
The name of the monitor.
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.
Defines the actual set of fields depending on the value. See one of the following objects:
BROWSER -> BrowserSyntheticMonitorUpdateHTTP -> HttpSyntheticMonitorUpdateBROWSERHTTPAnomalyDetection objectThe anomaly detection configuration.
LoadingTimeThresholdsPolicyDto objectPerformance thresholds configuration.
Performance threshold is enabled (true) or disabled (false).
LoadingTimeThreshold objectThe performance threshold rule.
Specify the event to which an ACTION threshold applies.
Specify the request to which an ACTION threshold applies.
The type of the threshold: total loading time or action loading time.
ACTIONTOTALNotify if monitor takes longer than X milliseconds to load.
OutageHandlingPolicy objectOutage handling configuration.
When enabled (true), generate a problem and send an alert when the monitor is unavailable at all configured locations.
When enabled (true), generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.
Local outage handling configuration.
Alert if affectedLocations of locations are unable to access the web application consecutiveRuns times consecutively.
Schedule retry if browser monitor execution results in a fail. For HTTP monitors this property is ignored.
GlobalOutagePolicy objectGlobal outage handling configuration.
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.
The number of affected locations to trigger an alert.
The number of consecutive fails to trigger an alert.
TagWithSourceInfo objectTag with source of a Dynatrace entity.
The origin of the tag, such as AWS or Cloud Foundry.
Custom tags use the CONTEXTLESS value.
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_CLOUDKUBERNETESThe key of the tag.
Custom tags have the tag value here.
The source of the tag, such as USER, RULE_BASED or AUTO
AUTORULE_BASEDUSERThe value of the tag.
Not applicable to custom tags.
{"name": "HTTP monitor","frequencyMin": 1,"enabled": true,"type": "HTTP","script": {"version": "1.0","requests": [{"description": "orf.at","url": "https://orf.at","method": "GET","requestBody": "","configuration": {"acceptAnyCertificate": true,"followRedirects": true},"preProcessingScript": "","postProcessingScript": ""}]},"locations": ["SYNTHETIC_LOCATION-61F43EECF5FB8345"],"anomalyDetection": {"outageHandling": {"globalOutage": true,"localOutage": false,"localOutagePolicy": {"affectedLocations": 1,"consecutiveRuns": 3}},"loadingTimeThresholds": {"enabled": false,"thresholds": [{"type": "TOTAL","valueMs": 10000}]}},"tags": [],"manuallyAssignedApps": ["APPLICATION-7ADA0EF404C7C545"]}