@dynatrace-sdk/client-synthetic

Create, read, update and delete synthetic monitors. Currently browser and network availability monitors only.

To authorize, use a valid OAuth token.

Notes about compatibility:

• Operations marked as early adopter or preview may be changed in non-compatible ways, although we try to avoid this.
• We may add new enum constants without incrementing the API version; thus, clients need to handle unknown enum constants gracefully.

Installation

npm install @dynatrace-sdk/client-synthetic

Getting help

• Visit SDK for Typescript guide in the Dynatrace Developer
• Ask a question in the Dynatrace Community

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

API reference

Full API reference for the latest version of the SDK is also available at the Dynatrace Developer.

syntheticMonitorsClient

import { syntheticMonitorsClient } from '@dynatrace-sdk/client-synthetic';

createMonitor

Creates a synthetic monitor definition. Currently browser and network availability monitors only. | maturity=EARLY_ADOPTER

Required scope: synthetic:monitors:write

Parameters

| Name | Type | | --- | --- | |config.body*required|SyntheticBrowserMonitorRequest | SyntheticMultiProtocolMonitorRequest|

Returns

| Return type | Status code | Description | |---|---|---| |MonitorEntityIdDto|200|Success|

Throws

| Error Type | Error Message | |---|---| |ErrorResponseEnvelopeError|Client side error. | Server side error.|

import { syntheticMonitorsClient } from "@dynatrace-sdk/client-synthetic";

const data = await syntheticMonitorsClient.createMonitor(
  {},
);

deleteMonitor

Deletes a synthetic monitor definition for the given monitor ID. Currently browser and network availability monitors only. | maturity=EARLY_ADOPTER

Required scope: synthetic:monitors:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.monitorId*required|string|The identifier of the monitor. |

Returns

| Return type | Status code | Description | |---|---|---| |void|204|Success. Response doesn't have a body.|

Throws

| Error Type | Error Message | |---|---| |ErrorResponseEnvelopeError|Client side error. | Server side error.|

import { syntheticMonitorsClient } from "@dynatrace-sdk/client-synthetic";

const data = await syntheticMonitorsClient.deleteMonitor({
  monitorId: "...",
});

getMonitor

Gets a synthetic monitor definition for the given monitor ID. Currently browser and network availability monitors only. | maturity=EARLY_ADOPTER

Required scope: synthetic:monitors:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.monitorId*required|string|The identifier of the monitor. |

Returns

| Return type | Status code | Description | |---|---|---| |SyntheticBrowserMonitorResponse|200|Success|

Throws

| Error Type | Error Message | |---|---| |ErrorResponseEnvelopeError|Client side error. | Server side error.|

import { syntheticMonitorsClient } from "@dynatrace-sdk/client-synthetic";

const data = await syntheticMonitorsClient.getMonitor({
  monitorId: "...",
});

getMonitors

Gets all synthetic monitors. Currently browser and network availability monitors only. | maturity=EARLY_ADOPTER

Required scope: synthetic:monitors:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.monitorSelector|string|Defines the scope of the query. Only monitors matching all criteria are included in the response. You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the OR logic applies. Monitor type: type(HTTP,MULTI_PROTOCOL). Possible values: 'HTTP', 'BROWSER', 'MULTI_PROTOCOL' (Note that only 'BROWSER' and 'MULTI_PROTOCOL' are currently supported). Synthetic Location ME ID: location(SYNTHETIC_LOCATION-123). Monitored host ME ID: monitoredEntity(HOST-123). Monitor tags: tag([context]key:value,key:value,key). Tags in [context]key:value, key:value, and key formats are detected and parsed automatically. If a key-only tag has a colon (:) in it, you must escape the colon with a backslash(\). Otherwise, the tag will be parsed as a key:value tag. All tag values are case-sensitive. Monitor enablement: enabled(true). To set several criteria, separate them with a comma (,). |

Returns

| Return type | Status code | Description | |---|---|---| |SyntheticMonitorListDto|200|Success|

Throws

| Error Type | Error Message | |---|---| |ErrorResponseEnvelopeError|Client side error. | Server side error.|

import { syntheticMonitorsClient } from "@dynatrace-sdk/client-synthetic";

const data = await syntheticMonitorsClient.getMonitors();

updateMonitor

Updates a synthetic monitor definition for the given monitor ID. Currently browser and network availability monitors only. | maturity=EARLY_ADOPTER

Required scope: synthetic:monitors:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.body*required|SyntheticBrowserMonitorRequest | SyntheticMultiProtocolMonitorRequest| | |config.monitorId*required|string|The identifier of the monitor. |

Returns

| Return type | Status code | Description | |---|---|---| |void|204|Success. Response doesn't have a body.|

Throws

| Error Type | Error Message | |---|---| |ErrorResponseEnvelopeError|Client side error. | Server side error.|

import { syntheticMonitorsClient } from "@dynatrace-sdk/client-synthetic";

const data = await syntheticMonitorsClient.updateMonitor({
  monitorId: "...",
});

syntheticOnDemandMonitorExecutionsClient

import { syntheticOnDemandMonitorExecutionsClient } from '@dynatrace-sdk/client-synthetic';

executeOnDemand

Triggers on-demand executions for synthetic monitors | maturity=EARLY_ADOPTER

Required scope: synthetic:monitors:execute

Parameters

| Name | Type | | --- | --- | |config.body*required|SyntheticOnDemandExecutionRequest|

Returns

| Return type | Status code | Description | |---|---|---| |SyntheticOnDemandExecutionResult|201|Created|

Throws

| Error Type | Error Message | |---|---| |ErrorResponseEnvelopeError|Client side error. | Server side error.|

import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-synthetic";

const data =
  await syntheticOnDemandMonitorExecutionsClient.executeOnDemand(
    { body: {} },
  );

rerunOnDemandExecution

Reruns specified on-demand execution of synthetic monitors | maturity=EARLY_ADOPTER

Required scope: synthetic:monitors:execute

Parameters

| Name | Type | Description | | --- | --- | --- | |config.executionId*required|number|The identifier of the on-demand execution. |

Returns

| Return type | Status code | Description | |---|---|---| |SyntheticOnDemandExecutionResult|200|Success|

Throws

| Error Type | Error Message | |---|---| |ErrorResponseEnvelopeError|Client side error. | Server side error.|

import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-synthetic";

const data =
  await syntheticOnDemandMonitorExecutionsClient.rerunOnDemandExecution(
    { executionId: 10 },
  );

Types

AuthenticationDto

Authentication dto for Browser Monitor step.

| Name | Type | Description | | --- | --- | --- | |authServerAllowlist|string|String containing the allowed servers of KERBEROS authentication. Can be defined only for KERBEROS authentication type. | |domain|string|String containing the KERBEROS authentication domain. Can be defined only for KERBEROS authentication type. | |inputType*required|"PLAIN" | "SECURE"|Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureAuthenticationDto PLAIN -> PlainAuthenticationDto | |type*required|"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"|Type of authentication. |

BaseWaitConditionDto

Wait condition for Browser Monitor step.

| Name | Type | Description | | --- | --- | --- | |type*required|"NETWORK" | "NEXT_EVENT" | "PAGE_COMPLETE" | "TIME" | "VALIDATION"|Defines the actual set of fields depending on the value. See one of the following objects: TIME -> TimeWaitConditionDto VALIDATION -> ValidationWaitConditionDto PAGE_COMPLETE -> BaseWaitConditionDto NETWORK -> BaseWaitConditionDto NEXT_EVENT -> BaseWaitConditionDto |

BrowserPermissionsDto

Permissions settings for browser.

| Name | Type | Description | | --- | --- | --- | |camera|boolean|Camera permission. If not defined in request, it will be set to false by default. | |location|boolean|Location permission. If not defined in request, it will be set to false by default. | |microphone|boolean|Microphone permission. If not defined in request, it will be set to false by default. | |notifications|boolean|Notifications permission. If not defined in request, it will be set to false by default. |

ChromiumStartupFlagsDto

Chromium startup flags of a Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |autoplay-policy|"no-user-gesture-required" | "document-user-activation-required"|autoplay-policy type. | |disable-features|ChromiumStartupFlagsDtoDisableFeatures|disable-features map | |disable-site-isolation-trials|boolean|disable-site-isolation-trials flag. | |disable-web-security|boolean|disable-web-security flag. If no value is passed, it will be set to false by default. | |host-resolver-rules|string|host-resolver-rules. | |ignore-certificate-errors|boolean|ignore-certificate-errors flag. | |ssl-version-max|string|ssl-version-max. | |ssl-version-min|string|ssl-version-min. | |test-type|boolean|test-type flag. |

ChromiumStartupFlagsDtoDisableFeatures

disable-features map

type: Record<string, boolean>

ClientCertificateDto

Client certificate.

| Name | Type | Description | | --- | --- | --- | |credentialId*required|string|Certificate CV id. | |domain*required|string|Domain certificate will be applied to. |

ConstraintViolation

Information about a single constraint violation.

| Name | Type | Description | | --- | --- | --- | |context|ConstraintViolationContext|Structured context of the constraint violation. Well known keys that can be present are: reason -> Additional reasoning behind the occurred violation. pipeline -> Pipeline related to the violation. endpoint -> Endpoint related to the violation. stage -> Stage related to the violation. processor -> Processor related to the violation. routingRule -> Routing rule related to the violation. | |message*required|string|Description of the constraint violation. |

ConstraintViolationContext

Structured context of the constraint violation. Well known keys that can be present are:

• reason -> Additional reasoning behind the occurred violation.
• pipeline -> Pipeline related to the violation.
• endpoint -> Endpoint related to the violation.
• stage -> Stage related to the violation.
• processor -> Processor related to the violation.
• routingRule -> Routing rule related to the violation.

type: Record<string, string>

ConstraintViolationDetails

List of encountered constraint violations.

| Name | Type | Description | | --- | --- | --- | |constraintViolations*required|Array<ConstraintViolation>|List of encountered constraint violations. | |type*required|"constraintViolation"|Defines the actual set of fields depending on the value. See one of the following objects: constraintViolation -> ConstraintViolationDetails |

CookieStepDto

Cookie step of Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |cookies*required|Array<SyntheticMonitorCookieDto>|Field containing the list of cookies. | |entityId|string|Entity Id. | |name*required|string|The name of Browser Monitor step. | |type*required|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto |

EnablementDto

Browser monitor enablement settings.

| Name | Type | Description | | --- | --- | --- | |enableOnGrail*required|boolean|Enable 3rd gen JS agent reporting. Relevant only for grail-enabled SaaS environments. | |origin|"MONITOR" | "TENANT" | "DEFAULT" | "UNKNOWN"|Indicates the origin of these settings. |

ErrorResponse

Basic information of the encountered error.

| Name | Type | Description | | --- | --- | --- | |code*required|number|The returned HTTP status code. | |details|ErrorResponseDetails|Detailed information of the error. | |message*required|string|Description of the encountered error. |

ErrorResponseDetails

Detailed information of the error.

| Name | Type | Description | | --- | --- | --- | |type*required|"constraintViolation"|Defines the actual set of fields depending on the value. See one of the following objects: constraintViolation -> ConstraintViolationDetails |

ErrorResponseEnvelope

Encloses the encountered error.

| Name | Type | Description | | --- | --- | --- | |error*required|ErrorResponse|Basic information of the encountered error. |

FilteredRequestsDto

Filtered requests of a Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |mode*required|"BLOCK" | "ALLOW"|Filter mode for filtered requests. | |requests*required|Array<RequestFilterDto>|Requests to be filtered. |

FrameworkOptionsDto

JS framework options of a JS Agent.

| Name | Type | Description | | --- | --- | --- | |activeXObject|boolean|activeXObject support. If not defined in request, it will be set to false by default. | |angular|boolean|Angular support. If not defined in request, it will be set to false by default. | |dojo|boolean|Dojo support. If not defined in request, it will be set to false by default. | |extJs|boolean|extJs support. If not defined in request, it will be set to false by default. | |icefaces|boolean|icefaces support. If not defined in request, it will be set to false by default. | |jQuery|boolean|jquery support. If not defined in request, it will be set to false by default. | |mooTools|boolean|mooTools support. If not defined in request, it will be set to false by default. | |prototype|boolean|prototype support. If not defined in request, it will be set to false by default. |

IgnoredErrorCodesDto

Ignored Error Codes of a Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |matchingDocumentRequests|string|Ignoring status codes will be applied to requests matching pattern. | |statusCodes|string|Status codes to be ignored. |

InteractionStepDto

Interaction step of Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |button*required|"MOUSE_LEFT" | "MOUSE_MIDDLE" | "MOUSE_RIGHT"|Integer containing the button index. | |entityId|string|Entity Id. | |name*required|string|The name of Browser Monitor step. | |target|TargetDto|Target of Browser Monitor step. | |type*required|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto | |validationRules|Array<ValidationRuleDto>|List of validation rules for the step to perform. | |waitCondition|BaseWaitConditionDto|Wait condition for Browser Monitor step. |

JavaScriptAgentSettingsDto

JavaScript Agent Settings.

| Name | Type | Description | | --- | --- | --- | |customProperties|string|Custom configuration properties | |experimentalValues|boolean|Experimental values support. If not defined in request, it will be set to false by default. | |fetchRequests|boolean|Capture fetch() requests. If not defined in request, it will be set to true by default. | |javaScriptErrors|boolean|Enable this setting to monitor JavaScript errors. The window.onError handler is used for capturing JavaScript errors. If not defined in request, it will be set to true by default. | |javaScriptFrameworkSupport|FrameworkOptionsDto|JS framework options of a JS Agent. | |timedActions|boolean|Within JavaScript frameworks, XHRs are often sent via setTimeout methods. Enable this setting to detect actions that trigger such XHRs. If not defined in request, it will be set to true by default. | |timeoutSettings|TimeoutSettingsDto|Timeout settings of a Browser Monitor. | |visuallyCompleteOptions|VisuallyCompleteOptionsDto|Visually Complete Options of a Browser Monitor. | |xmlHttpRequests|boolean|Capture xml Http requests (XHR). If not defined in request, it will be set to true by default. |

JavaScriptStepDto

JavaScript step of Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |entityId|string|Entity Id. | |javaScript*required|string|String containing a script in JavaScript. | |name*required|string|The name of Browser Monitor step. | |target|TargetDto|Target of Browser Monitor step. | |type*required|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto | |waitCondition|BaseWaitConditionDto|Wait condition for Browser Monitor step. |

KeyPerformanceMetrics

The key performance metrics configuration.

| Name | Type | Description | | --- | --- | --- | |loadActionKpm|"USER_ACTION_DURATION" | "VISUALLY_COMPLETE" | "SPEED_INDEX" | "DOM_INTERACTIVE" | "LOAD_EVENT_START" | "LOAD_EVENT_END" | "RESPONSE_START" | "RESPONSE_END" | "LARGEST_CONTENTFUL_PAINT" | "CUMULATIVE_LAYOUT_SHIFT"|Load action key performance metric. | |xhrActionKpm|"USER_ACTION_DURATION" | "VISUALLY_COMPLETE" | "RESPONSE_START" | "RESPONSE_END"|XHR action key performance metric. |

KeyStrokesStepDto

Key strokes step of Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |entityId|string|Entity Id. | |input*required|KeystrokesInputDto|Key strokes step input. | |name*required|string|The name of Browser Monitor step. | |simulateBlurEvent|boolean|Boolean value set to true if blur event should be simulated. | |simulateReturnKey|boolean|Boolean value set to true if return key should be simulated. | |target|TargetDto|Target of Browser Monitor step. | |type*required|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto | |validationRules|Array<ValidationRuleDto>|List of validation rules for the step to perform. | |waitCondition|BaseWaitConditionDto|Wait condition for Browser Monitor step. |

KeystrokesInputDto

Key strokes step input.

| Name | Type | Description | | --- | --- | --- | |type*required|"PLAIN" | "SECURE"|Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureKeystrokesInputDto PLAIN -> PlainKeystrokesInputDto |

LocatorDto

Browser Monitor locator.

| Name | Type | Description | | --- | --- | --- | |type*required|"CSS" | "DOM"|Enum value of the locator type. | |value*required|string|Value of the locator. |

MonitorEntityIdDto

A DTO for monitor entity ID.

| Name | Type | Description | | --- | --- | --- | |entityId*required|string|Monitor entity ID. |

MonitorPropertyDto

Property of a Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |name*required|string|Property name. | |value*required|string|Property value. |

MonitorRequestHeader

A header of the Http request

| Name | Type | Description | | --- | --- | --- | |name*required|string|Header's name. | |value*required|string|Header's value. |

NavigateStepDto

Step of Browser Monitor that navigates to a website.

| Name | Type | Description | | --- | --- | --- | |authentication|AuthenticationDto|Authentication dto for Browser Monitor step. | |entityId|string|Entity Id. | |name*required|string|The name of Browser Monitor step. | |target|TargetDto|Target of Browser Monitor step. | |type*required|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto | |url*required|string|Field containing the url that the monitor should navigate to. | |validationRules|Array<ValidationRuleDto>|List of validation rules for the step to perform. | |waitCondition|BaseWaitConditionDto|Wait condition for Browser Monitor step. |

NetworkThrottlingDto

Network throttling of a Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |download|number|Download throughput. If not defined in request, it will be set to -1 by default. | |latency|number|Latency. If not defined in request, it will be set to 0 by default. | |name|string|Predefined network type. If not defined in request, it will be set to "" by default. | |upload|number|Upload throughput. If not defined in request, it will be set to -1 by default. |

PlainAuthenticationDto

Plain authentication dto for Browser Monitor step.

| Name | Type | Description | | --- | --- | --- | |authServerAllowlist|string|String containing the allowed servers of KERBEROS authentication. Can be defined only for KERBEROS authentication type. | |domain|string|String containing the KERBEROS authentication domain. Can be defined only for KERBEROS authentication type. | |inputType*required|"PLAIN" | "SECURE"|Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureAuthenticationDto PLAIN -> PlainAuthenticationDto | |password*required|string|String containing the password. | |type*required|"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"|Type of authentication. | |username*required|string|String containing the username. |

PlainKeystrokesInputDto

Credential-based input for keystrokes step.

| Name | Type | Description | | --- | --- | --- | |masked|boolean|Boolean value set to true only if key strokes input textValue field is encoded by recorder and should be decoded by VUP. Set to false by default. | |textValue*required|string|String value containing the text. | |type*required|"PLAIN" | "SECURE"|Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureKeystrokesInputDto PLAIN -> PlainKeystrokesInputDto |

ProxyDto

Browser Monitor proxy.

| Name | Type | Description | | --- | --- | --- | |pacUrl*required|string|pacUrl |

RequestFilterDto

Request filter for Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |matchingPattern*required|string|Regex for request that filter will be applied to. | |type*required|"STARTS_WITH" | "ENDS_WITH" | "CONTAINS" | "EQUALS" | "REGEX"|Filter type. |

RequestHeaderOptionsDto

Header Options of a Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |matchingPatterns*required|Array<string>|Apply headers to requests matching pattern. | |requestHeaders*required|Array<MonitorRequestHeader>|Request headers list. |

SecureAuthenticationDto

Secure authentication dto for Browser Monitor step.

| Name | Type | Description | | --- | --- | --- | |authServerAllowlist|string|String containing the allowed servers of KERBEROS authentication. Can be defined only for KERBEROS authentication type. | |credentialId*required|string|Id of the username and password credential which will be used for authentication. | |domain|string|String containing the KERBEROS authentication domain. Can be defined only for KERBEROS authentication type. | |inputType*required|"PLAIN" | "SECURE"|Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureAuthenticationDto PLAIN -> PlainAuthenticationDto | |type*required|"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"|Type of authentication. |

SecureKeystrokesInputDto

Credential-based input for keystrokes step.

| Name | Type | Description | | --- | --- | --- | |credentialField*required|"USERNAME" | "PASSWORD" | "TOKEN"|Enum value of the credential field. | |credentialId*required|string|String value containing the credential id. | |type*required|"PLAIN" | "SECURE"|Defines the actual set of fields depending on the value. See one of the following objects: SECURE -> SecureKeystrokesInputDto PLAIN -> PlainKeystrokesInputDto |

SelectOptionStepDto

Select option step of Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |entityId|string|Entity Id. | |name*required|string|The name of Browser Monitor step. | |selections*required|Array<SelectionDto>|Field containing the credential. | |target|TargetDto|Target of Browser Monitor step. | |type*required|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto | |validationRules|Array<ValidationRuleDto>|List of validation rules for the step to perform. | |waitCondition|BaseWaitConditionDto|Wait condition for Browser Monitor step. |

SelectionDto

Option selection for Browser Monitor step.

| Name | Type | Description | | --- | --- | --- | |index*required|number|Selection index. | |value*required|string|Selection value. |

SyntheticBrowserMonitorConfigurationDto

Browser Monitor configuration.

| Name | Type | Description | | --- | --- | --- | |blockedRequests|Array<string>|All requests matching the specified patterns will be blocked during the execution of the monitor. | |browserPermissions|BrowserPermissionsDto|Permissions settings for browser. | |bypassCSP|boolean|Bypass ContentSecurity Policy for monitored pages. If not defined in request, it will be set to false by default. | |chromiumStartupFlags|ChromiumStartupFlagsDto|Chromium startup flags of a Browser Monitor. | |clientCertificates|Array<ClientCertificateDto>|Identifier of stored client's certificate. | |cookies|Array<SyntheticMonitorCookieDto>|Cookies list. | |device*required|TestDeviceDto|Test device of a Browser Monitor. | |enablement|EnablementDto|Browser monitor enablement settings. | |experimentalProperties|Array<MonitorPropertyDto>|Experimental properties list. | |filteredRequests|FilteredRequestsDto|Filtered requests of a Browser Monitor. | |ignoredErrorCodes|IgnoredErrorCodesDto|Ignored Error Codes of a Browser Monitor. | |javaScriptSettings|JavaScriptAgentSettingsDto|JavaScript Agent Settings. | |monitorFrames|boolean|Capture performance metrics for pages loaded in frames. If not defined in request, it will be set to false by default. | |networkThrottling|NetworkThrottlingDto|Network throttling of a Browser Monitor. | |proxy|ProxyDto|Browser Monitor proxy. | |requestHeaderOptions|RequestHeaderOptionsDto|Header Options of a Browser Monitor. | |useIESupportedAgent|boolean|useIESupportedAgent flag. If not defined in request, it will be set to false by default. | |userAgent|string|User agent |

SyntheticBrowserMonitorRequest

Browser monitor update.

| Name | Type | Description | | --- | --- | --- | |configuration*required|SyntheticBrowserMonitorConfigurationDto|Browser Monitor configuration. | |description|string|Monitor description | |enabled|boolean|If true, the monitor is enabled. default: true| |frequencyMin|number|The frequency of the monitor, in minutes. Default value depends on the monitor type (1 minute for MULTI_PROTOCOL and HTTP, 15 minutes for BROWSER). | |keyPerformanceMetrics|KeyPerformanceMetrics|The key performance metrics configuration. | |locations*required|Array<string>|The locations to which the monitor is assigned. | |manuallyAssignedEntities|Array<string>|Manually assigned entities. | |name*required|string|The name of the monitor. | |performanceThresholds|SyntheticMonitorPerformanceThresholdsDto|Performance thresholds configuration. | |primaryGrailTags|Array<SyntheticMonitorPrimaryGrailTagDto>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. | |securityContext|Array<string>|[FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed. | |steps*required|Array<SyntheticBrowserMonitorStepDto>|The steps of the monitor. | |syntheticMonitorOutageHandlingSettings|SyntheticMonitorOutageHandlingSettingsDto|Outage handling configuration. | |tags|Array<SyntheticTagWithSourceDto>|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 SyntheticTagWithSourceDto model. | |type*required|"MULTI_PROTOCOL" | "BROWSER" | "HTTP"|Monitor type. |

SyntheticBrowserMonitorResponse

Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |automaticallyAssignedEntities|Array<string>|Automatically assigned entities. | |configuration*required|SyntheticBrowserMonitorConfigurationDto|Browser Monitor configuration. | |description|string|Monitor description | |enabled|boolean|If true, the monitor is enabled. | |entityId*required|string|The entity id of the monitor. | |frequencyMin|number|The frequency of the monitor, in minutes. | |keyPerformanceMetrics*required|KeyPerformanceMetrics|The key performance metrics configuration. | |locations|Array<string>|The locations to which the monitor is assigned. | |manuallyAssignedEntities|Array<string>|Manually assigned entities. | |modificationTimestamp|number|The timestamp of the last modification | |name|string|The name of the monitor. | |performanceThresholds|SyntheticMonitorPerformanceThresholdsDto|Performance thresholds configuration. | |primaryGrailTags|Array<SyntheticMonitorPrimaryGrailTagDto>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. | |securityContext|Array<string>|[FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed. | |steps*required|Array<SyntheticBrowserMonitorStepDto>|The steps of the monitor. | |syntheticMonitorOutageHandlingSettings*required|SyntheticMonitorOutageHandlingSettingsDto|Outage handling configuration. | |tags|Array<SyntheticTagWithSourceDto>|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 SyntheticTagWithSourceDto model. | |type*required|"MULTI_PROTOCOL" | "BROWSER"|Monitor type. |

SyntheticBrowserMonitorStepDto

Base step of Browser Monitor.

| Name | Type | Description | | --- | --- | --- | |entityId|string|Entity Id. | |name*required|string|The name of Browser Monitor step. | |type*required|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|Defines the actual set of fields depending on the value. See one of the following objects: NAVIGATE -> NavigateStepDto CLICK -> InteractionStepDto TAP -> InteractionStepDto KEYSTROKES -> KeyStrokesStepDto JAVASCRIPT -> JavaScriptStepDto SELECT_OPTION -> SelectOptionStepDto COOKIE -> CookieStepDto |

SyntheticMonitorConstraintDto

Synthetic monitor constraint. The allowed type and properties depend on the monitor and step/request context.

| Name | Type | Description | | --- | --- | --- | |properties*required|SyntheticMonitorConstraintDtoProperties|Constraint properties. Most constraint types use operator and value keys. Some protocol-specific constraints may use additional keys, for example DNS_STATUS_CODE can use status. | |type*required|string|Constraint type. Allowed values depend on monitor type and step/request context. HTTP monitor step constraints: HTTP_STATUSES, HTTP_RESPONSE_PATTERN, HTTP_RESPONSE_REGEX. Network availability monitor(MULTI_PROTOCOL) step constraints: SUCCESS_RATE_PERCENT. Network availability monitor(MULTI_PROTOCOL) request configuration constraints are request-type specific, for example ICMP_SUCCESS_RATE_PERCENT (ICMP) and DNS_STATUS_CODE (DNS). |

SyntheticMonitorConstraintDtoProperties

Constraint properties. Most constraint types use operator and value keys. Some protocol-specific constraints may use additional keys, for example DNS_STATUS_CODE can use status.

type: Record<string, string>

SyntheticMonitorCookieDto

Cookie dto for Synthetic Monitor step.

| Name | Type | Description | | --- | --- | --- | |domain*required|string|Cookie domain. | |name*required|string|Cookie name. | |path|string|Cookie path. | |value*required|string|Cookie value. |

SyntheticMonitorListDto

List of available synthetic monitors.

| Name | Type | Description | | --- | --- | --- | |monitors|Array<SyntheticMonitorSummaryDto>|List of monitors. |

SyntheticMonitorOutageHandlingSettingsDto

Outage handling configuration.

| Name | Type | Description | | --- | --- | --- | |globalConsecutiveOutageCountThreshold|number|Number of consecutive failures for all locations. | |globalOutages*required|boolean|Generate a problem and send an alert when the monitor is unavailable at all configured locations. | |localConsecutiveOutageCountThreshold|number|Number of consecutive failures. | |localLocationOutageCountThreshold|number|Number of failing locations. | |localOutages*required|boolean|Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. | |origin|"MONITOR" | "TENANT" | "DEFAULT" | "UNKNOWN"|Indicates the origin of these settings. | |retryOnError|boolean|Only Browser Monitor property. If set to true, execution retry will take place in case the monitor fails. |

SyntheticMonitorPerformanceThresholdDto

The performance threshold rule.

| Name | Type | Description | | --- | --- | --- | |aggregation|"AVG" | "MAX" | "MIN"|Aggregation type default: "AVG"| |dealertingSamples|number|Number of most recent non-violating request executions that closes the problem. | |samples|number|Number of request executions in analyzed sliding window (sliding window size). | |stepIndex|number|Specify the step's index to which a threshold applies. If threshold is monitor-level, no index is needed. | |threshold*required|number|Notify if monitor request takes longer than X time units to execute. For network availability monitors the time unit is milliseconds, for browser and HTTP monitors - seconds. | |type|"MONITOR" | "STEP"|Type of performance threshold. | |violatingSamples|number|Number of violating request executions in analyzed sliding window. |

SyntheticMonitorPerformanceThresholdsDto

Performance thresholds configuration.

| Name | Type | Description | | --- | --- | --- | |enabled*required|boolean|Performance threshold is enabled (true) or disabled (false). | |thresholds|Array<SyntheticMonitorPerformanceThresholdDto>|The list of performance threshold rules. |

SyntheticMonitorPrimaryGrailTagDto

Primary grail tag key-value pair.

| Name | Type | Description | | --- | --- | --- | |key*required|string|Tag key. | |value*required|string|Tag value. |

SyntheticMonitorSummaryDto

Basic monitor data.

| Name | Type | Description | | --- | --- | --- | |enabled|boolean|If true, the monitor is enabled. default: true| |entityId*required|string|The entity id of the monitor. | |name*required|string|The name of the monitor. | |type*required|"MULTI_PROTOCOL" | "BROWSER" | "HTTP" | "THIRD_PARTY"| |

SyntheticMultiProtocolMonitorRequest

Network availability monitor.

| Name | Type | Description | | --- | --- | --- | |description|string|Monitor description | |enabled|boolean|If true, the monitor is enabled. default: true| |frequencyMin|number|The frequency of the monitor, in minutes. Default value depends on the monitor type (1 minute for MULTI_PROTOCOL and HTTP, 15 minutes for BROWSER). | |locations*required|Array<string>|The locations to which the monitor is assigned. | |name*required|string|The name of the monitor. | |performanceThresholds|SyntheticMonitorPerformanceThresholdsDto|Performance thresholds configuration. | |primaryGrailTags|Array<SyntheticMonitorPrimaryGrailTagDto>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. | |securityContext|Array<string>|[FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed. | |steps*required|Array<SyntheticMultiProtocolMonitorStepDto>|The steps of the monitor. | |syntheticMonitorOutageHandlingSettings|SyntheticMonitorOutageHandlingSettingsDto|Outage handling configuration. | |tags|Array<SyntheticTagWithSourceDto>|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 SyntheticTagWithSourceDto model. | |type*required|"MULTI_PROTOCOL" | "BROWSER" | "HTTP"|Monitor type. |

SyntheticMultiProtocolMonitorResponse

Network availability monitor.

| Name | Type | Description | | --- | --- | --- | |description|string|Monitor description | |enabled|boolean|If true, the monitor is enabled. | |entityId*required|string|The entity id of the monitor. | |frequencyMin|number|The frequency of the monitor, in minutes. | |locations|Array<string>|The locations to which the monitor is assigned. | |modificationTimestamp|number|The timestamp of the last modification | |name|string|The name of the monitor. | |performanceThresholds|SyntheticMonitorPerformanceThresholdsDto|Performance thresholds configuration. | |primaryGrailTags|Array<SyntheticMonitorPrimaryGrailTagDto>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. | |securityContext|Array<string>|[FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed. | |steps*required|Array<SyntheticMultiProtocolMonitorStepDto>|The steps of the monitor. | |syntheticMonitorOutageHandlingSettings*required|SyntheticMonitorOutageHandlingSettingsDto|Outage handling configuration. | |tags|Array<SyntheticTagWithSourceDto>|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 SyntheticTagWithSourceDto model. | |type*required|"MULTI_PROTOCOL" | "BROWSER"|Monitor type. |

SyntheticMultiProtocolMonitorStepDto

The step of a network availability monitor.

| Name | Type | Description | | --- | --- | --- | |constraints*required|Array<SyntheticMonitorConstraintDto>|The list of constraints which apply to all requests in the step. | |name*required|string|Step name. | |properties*required|SyntheticMultiProtocolMonitorStepDtoProperties|The properties which apply to all requests in the step. | |requestConfigurations*required|Array<SyntheticMultiProtocolRequestConfigurationDto>|Request configurations. | |requestType*required|"ICMP" | "TCP" | "DNS"|Request type. | |targetFilter|string|Target filter. | |targetList|Array<string>|Target list. |

SyntheticMultiProtocolMonitorStepDtoProperties

The properties which apply to all requests in the step.

type: Record<string, string>

SyntheticMultiProtocolRequestConfigurationDto

The configuration of a network availability monitor request.

| Name | Type | Description | | --- | --- | --- | |constraints*required|Array<SyntheticMonitorConstraintDto>|Request constraints. |

SyntheticOnDemandExecutionRequest

Contains parameters for the on-demand execution of monitors identified by tags, applications, or services.

| Name | Type | Description | | --- | --- | --- | |failOnPerformanceIssue|boolean|If true, the execution will fail in case of performance issue. default: true| |failOnSslWarning|boolean|Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing. default: true| |group|SyntheticOnDemandExecutionRequestGroup|Contains parameters for the on-demand execution of monitors identified by tags, applications, or services. | |metadata|SyntheticOnDemandExecutionRequestMetadata|String to string map of metadata properties for execution | |monitors|Array<SyntheticOnDemandExecutionRequestMonitor>|List of monitors to be triggered. | |processingMode|"STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The execution's processing mode default: "STANDARD"| |stopOnProblem|boolean|If true, no executions will be scheduled if a problem occurs. default: false| |takeScreenshotsOnSuccess|boolean|If true, the screenshots will be taken during the execution of a browser monitor. default: false|

SyntheticOnDemandExecutionRequestGroup

Contains parameters for the on-demand execution of monitors identified by tags, applications, or services.

| Name | Type | Description | | --- | --- | --- | |applications|Array<string>|List of application identifiers. Only monitors with all applications assigned will be executed. | |locations|Array<string>|The locations from where monitors are to be executed. | |services|Array<string>|List of service identifiers. Only monitors with all services assigned will be executed. | |tags|Array<string>|List of tags. Only monitors with all tags assigned will be executed. |

SyntheticOnDemandExecutionRequestMetadata

String to string map of metadata properties for execution

type: Record<string, string>

SyntheticOnDemandExecutionRequestMonitor

Contains monitors to be executed on demand from the locations specified.

| Name | Type | Description | | --- | --- | --- | |customizedScript|SyntheticOnDemandExecutionRequestMonitorCustomizedScript|Customized script properties for this on-demand batch execution. | |executionCount|number|The numb