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: |
required |
| enabled | boolean |
The monitor is enabled ( |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| createdFrom | string |
The origin of a monitor The createdFrom element can hold these values. |
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. The loadActionKpm element can hold these values. |
required |
| xhrActionKpm | string |
Defines the key performance metric for XHR actions. The xhrActionKpm element can hold these values. |
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 The source element can hold these values. |
optional |
| context | string |
The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
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 ( |
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. The type element can hold these values. |
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 |
The OutageHandlingPolicy object
Outage handling configuration.
| Element | Type | Description | Required |
|---|---|---|---|
| globalOutage | boolean |
When enabled ( |
required |
| localOutage | boolean |
When enabled ( |
required |
| localOutagePolicy | LocalOutagePolicy | required |
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 |
Possible values
Possible values for the xhrActionKpm element in the KeyPerformanceMetrics object:
- VISUALLY_COMPLETE
- USER_ACTION_DURATION
- TIME_TO_FIRST_BYTE
- RESPONSE_END
Possible values for the loadActionKpm element in the KeyPerformanceMetrics object:
- VISUALLY_COMPLETE
- SPEED_INDEX
- USER_ACTION_DURATION
- TIME_TO_FIRST_BYTE
- HTML_DOWNLOADED
- DOM_INTERACTIVE
- LOAD_EVENT_START
- LOAD_EVENT_END
Possible values for the context element in the TagWithSourceInfo object:
- AWS
- AWS_GENERIC
- AZURE
- CLOUD_FOUNDRY
- CONTEXTLESS
- ENVIRONMENT
- GOOGLE_CLOUD
- KUBERNETES
Possible values for the source element in the TagWithSourceInfo object:
- AUTO
- RULE_BASED
- USER
Possible values for the type element in the LoadingTimeThreshold object:
- ACTION
- TOTAL
Possible values for the createdFrom element:
- API
- GUI
Possible values for the type element:
- BROWSER
- HTTP
{
"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
}
]
}
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: |
required |
| enabled | boolean |
The monitor is enabled ( |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| createdFrom | string |
The origin of a monitor The createdFrom element can hold these values. |
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 The source element can hold these values. |
optional |
| context | string |
The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
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 ( |
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. The type element can hold these values. |
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 |
The OutageHandlingPolicy object
Outage handling configuration.
| Element | Type | Description | Required |
|---|---|---|---|
| globalOutage | boolean |
When enabled ( |
required |
| localOutage | boolean |
When enabled ( |
required |
| localOutagePolicy | LocalOutagePolicy | required |
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 |
Possible values
Possible values for the context element in the TagWithSourceInfo object:
- AWS
- AWS_GENERIC
- AZURE
- CLOUD_FOUNDRY
- CONTEXTLESS
- ENVIRONMENT
- GOOGLE_CLOUD
- KUBERNETES
Possible values for the source element in the TagWithSourceInfo object:
- AUTO
- RULE_BASED
- USER
Possible values for the type element in the LoadingTimeThreshold object:
- ACTION
- TOTAL
Possible values for the createdFrom element:
- API
- GUI
Possible values for the type element:
- BROWSER
- HTTP
{
"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
}
]
}
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: |
required |
| anomalyDetection | AnomalyDetection | optional | |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
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 ( |
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 |
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. The loadActionKpm element can hold these values. |
required |
| xhrActionKpm | string |
Defines the key performance metric for XHR actions. The xhrActionKpm element can hold these values. |
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 The source element can hold these values. |
optional |
| context | string |
The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
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 ( |
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. The type element can hold these values. |
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 |
The OutageHandlingPolicy object
Outage handling configuration.
| Element | Type | Description | Required |
|---|---|---|---|
| globalOutage | boolean |
When enabled ( |
required |
| localOutage | boolean |
When enabled ( |
required |
| localOutagePolicy | LocalOutagePolicy | required |
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 |
Possible values
Possible values for the xhrActionKpm element in the KeyPerformanceMetrics object:
- VISUALLY_COMPLETE
- USER_ACTION_DURATION
- TIME_TO_FIRST_BYTE
- RESPONSE_END
Possible values for the loadActionKpm element in the KeyPerformanceMetrics object:
- VISUALLY_COMPLETE
- SPEED_INDEX
- USER_ACTION_DURATION
- TIME_TO_FIRST_BYTE
- HTML_DOWNLOADED
- DOM_INTERACTIVE
- LOAD_EVENT_START
- LOAD_EVENT_END
Possible values for the context element in the TagWithSourceInfo object:
- AWS
- AWS_GENERIC
- AZURE
- CLOUD_FOUNDRY
- CONTEXTLESS
- ENVIRONMENT
- GOOGLE_CLOUD
- KUBERNETES
Possible values for the source element in the TagWithSourceInfo object:
- AUTO
- RULE_BASED
- USER
Possible values for the type element:
- BROWSER
- HTTP
Possible values for the type element in the LoadingTimeThreshold object:
- ACTION
- TOTAL
{
"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"
}
}
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: |
required |
| anomalyDetection | AnomalyDetection | optional | |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
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 ( |
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 |
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 The source element can hold these values. |
optional |
| context | string |
The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
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 ( |
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. The type element can hold these values. |
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 |
The OutageHandlingPolicy object
Outage handling configuration.
| Element | Type | Description | Required |
|---|---|---|---|
| globalOutage | boolean |
When enabled ( |
required |
| localOutage | boolean |
When enabled ( |
required |
| localOutagePolicy | LocalOutagePolicy | required |
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 |
Possible values
Possible values for the context element in the TagWithSourceInfo object:
- AWS
- AWS_GENERIC
- AZURE
- CLOUD_FOUNDRY
- CONTEXTLESS
- ENVIRONMENT
- GOOGLE_CLOUD
- KUBERNETES
Possible values for the source element in the TagWithSourceInfo object:
- AUTO
- RULE_BASED
- USER
Possible values for the type element:
- BROWSER
- HTTP
Possible values for the type element in the LoadingTimeThreshold object:
- ACTION
- TOTAL
{
"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"
]
}