Manage scripted browser monitors

New Relic allows you use NerdGraph to create scripted browser monitors. Scripted browser monitors execute custom JavaScript code in a real browser environment, allowing you to simulate complex user interactions and multi-step workflows. This tutorial provides examples of how to use the NerdGraph API to automate the creation of scripted browser monitors.

Create a scripted browser monitor

You can create a scripted browser monitor using the syntheticsCreateScriptBrowserMonitor mutation. This mutation allows you to set up custom scripted monitoring that executes your JavaScript code in a browser.

Input parameters

Parameter	Data Type	Is it Required?	Description
`accountId`	Integer	Yes	Your New Relic account ID where the monitor will be created.
`monitor.browsers`	Array	Yes	Browser(s) that the monitor will use to execute jobs. Supported browsers: `CHROME`, `EDGE`, `FIREFOX`.
`monitor.devices`	Array	Yes	Devices that the monitor will use to execute jobs. Supported devices: `DESKTOP`, `MOBILE_LANDSCAPE`, `MOBILE_PORTRAIT`, `TABLET_LANDSCAPE`, `TABLET_PORTRAIT`.
`monitor.locations.public`	Array	Yes	Array of public location identifiers where the monitor will run checks (e.g., `["US_EAST_1", "US_WEST_1"]`).
`monitor.name`	String	Yes	The display name for your scripted browser monitor.
`monitor.period`	Enum	Yes	How often the monitor runs. Options: `EVERY_MINUTE`, `EVERY_5_MINUTES`, `EVERY_10_MINUTES`, `EVERY_15_MINUTES`, `EVERY_30_MINUTES`, `EVERY_HOUR`, `EVERY_6_HOURS`, `EVERY_12_HOURS`, `EVERY_DAY`.
`monitor.runtime.runtimeType`	String	Yes	The runtime type used by your monitor. `CHROME_BROWSER` is the only accepted value.
`monitor.runtime.runtimeTypeVersion`	String	Yes	The runtime type version used by your monitor. `100` is the only accepted value.
`monitor.runtime.scriptLanguage`	String	Yes	The language used in your monitor. `JAVASCRIPT` is the only accepted value.
`monitor.script`	String	Yes	The JavaScript code that the monitor executes. This should be plain text, not base64 encoded. The script can use Selenium WebDriver APIs to control the browser.
`monitor.status`	Enum	Yes	The monitor status. Options: `ENABLED` (monitor is active and performing checks), `DISABLED` (monitor is inactive).
`monitor.advancedOptions.enableScreenshotOnFailureAndScript`	Boolean	No	Captures a screenshot during job execution when a failure occurs or a script is executed.
`monitor.apdexTarget`	Float	No	The monitor's Apdex target in seconds, used to populate SLA reports. Defaults to 7.0 seconds.

Sample request

mutation {
 syntheticsCreateScriptBrowserMonitor(
 accountId: ACCOUNT_ID
 monitor: {
 browsers: [BROWSERS]
 devices: [DEVICES]
 locations: { public: ["LOCATION_1", "LOCATION_2"] }
 name: "MONITOR_NAME"
 period: PERIOD
 runtime: {
 runtimeType: "RUNTIME_TYPE"
 runtimeTypeVersion: "RUNTIME_TYPE_VERSION"
 scriptLanguage: "SCRIPT_LANGUAGE"
 }
 script: "SCRIPT_CONTENT"
 status: STATUS
 advancedOptions: { enableScreenshotOnFailureAndScript: ENABLE_SCREENSHOT }
 apdexTarget: APDEX_TARGET
 }
 ) {
 errors {
 description
 type
 }
 }
}

Sample response

A successful response returns null for errors:

{
 "data": {
 "syntheticsCreateScriptBrowserMonitor": {
 "errors": null
 }
 }
}

If there are any issues creating the monitor, the errors array will contain objects with description and type fields explaining what went wrong.

Update a scripted browser monitor

You can update an existing scripted browser monitor using the syntheticsUpdateScriptBrowserMonitor mutation. This allows you to modify the configuration of a scripted browser monitor that has already been created.

Input parameters

Parameter	Data Type	Is it Required?	Description
`guid`	String	Yes	The unique entity GUID of the monitor you want to update.
`monitor.browsers`	Array	No	Browser(s) that the monitor will use to execute jobs. Supported browsers: `CHROME`, `EDGE`, `FIREFOX`.
`monitor.devices`	Array	No	Devices that the monitor will use to execute jobs. Supported devices: `DESKTOP`, `MOBILE_LANDSCAPE`, `MOBILE_PORTRAIT`, `TABLET_LANDSCAPE`, `TABLET_PORTRAIT`.
`monitor.locations.public`	Array	No	Array of public location identifiers where the monitor will run checks (e.g., `["US_EAST_1", "US_WEST_1"]`).
`monitor.name`	String	No	The updated display name for your scripted browser monitor.
`monitor.period`	Enum	No	How often the monitor runs. Options: `EVERY_MINUTE`, `EVERY_5_MINUTES`, `EVERY_10_MINUTES`, `EVERY_15_MINUTES`, `EVERY_30_MINUTES`, `EVERY_HOUR`, `EVERY_6_HOURS`, `EVERY_12_HOURS`, `EVERY_DAY`.
`monitor.runtime.runtimeType`	String	No	The runtime type used by your monitor. `CHROME_BROWSER` is the only accepted value.
`monitor.runtime.runtimeTypeVersion`	String	No	The runtime type version used by your monitor. `100` is the only accepted value.
`monitor.runtime.scriptLanguage`	String	No	The language used in your monitor. `JAVASCRIPT` is the only accepted value.
`monitor.script`	String	No	The JavaScript code that the monitor executes. This should be plain text, not base64 encoded.
`monitor.status`	Enum	No	The monitor status. Options: `ENABLED` (monitor is active and performing checks), `DISABLED` (monitor is inactive).
`monitor.advancedOptions.enableScreenshotOnFailureAndScript`	Boolean	No	Captures a screenshot during job execution when a failure occurs or a script is executed.
`monitor.apdexTarget`	Float	No	The monitor's Apdex target in seconds, used to populate SLA reports. Defaults to 7.0 seconds.

Sample request

mutation {
 syntheticsUpdateScriptBrowserMonitor(
 guid: ENTITY_GUID
 monitor: {
 browsers: [BROWSERS]
 devices: [DEVICES]
 locations: { public: ["LOCATION_1", "LOCATION_2"] }
 name: "MONITOR_NAME"
 period: PERIOD
 runtime: {
 runtimeType: "RUNTIME_TYPE"
 runtimeTypeVersion: "RUNTIME_TYPE_VERSION"
 scriptLanguage: "SCRIPT_LANGUAGE"
 }
 script: "SCRIPT_CONTENT"
 status: STATUS
 advancedOptions: { enableScreenshotOnFailureAndScript: ENABLE_SCREENSHOT }
 apdexTarget: APDEX_TARGET
 }
 ) {
 errors {
 description
 type
 }
 }
}

Sample response

A successful response returns null for errors:

{
 "data": {
 "syntheticsUpdateScriptBrowserMonitor": {
 "errors": null
 }
 }
}

If there are any issues updating the monitor, the errors array will contain objects with description and type fields explaining what went wrong.

Upgrade a scripted browser monitor's runtime

You can upgrade a scripted browser monitor to use the newer Chrome 100+ runtime. This ensures your monitor uses the latest browser features and security updates.

Input parameters

Parameter	Data Type	Is it Required?	Description
`guid`	String	Yes	The unique entity GUID of the monitor you want to upgrade.
`monitor.runtime.runtimeType`	String	Yes	The runtime type. `CHROME_BROWSER` is the only accepted value.
`monitor.runtime.runtimeTypeVersion`	String	Yes	The runtime version. `100` is the only accepted value.
`monitor.runtime.scriptLanguage`	String	Yes	The scripting language. `JAVASCRIPT` is the only accepted value.

Sample request

mutation {
 syntheticsUpdateScriptBrowserMonitor(
 guid: "ENTITY_GUID"
 monitor: {
 runtime: {
 runtimeType: "CHROME_BROWSER"
 runtimeTypeVersion: "100"
 scriptLanguage: "JAVASCRIPT"
 }
 }
 ) {
 errors {
 description
 type
 }
 }
}

Sample response

A successful response returns null for errors:

{
 "data": {
 "syntheticsUpdateScriptBrowserMonitor": {
 "errors": null
 }
 }
}

If there are any issues upgrading the monitor runtime, the errors array will contain objects with description and type fields explaining what went wrong.

Downgrade a scripted browser monitor's runtime

You can downgrade a scripted browser monitor to use a legacy runtime. This may be necessary for compatibility reasons, but note that legacy runtimes will be end-of-life on October 22, 2024.

Important

Legacy runtimes are deprecated and will be end-of-life on October 22, 2024. Downgrading to legacy runtimes is not recommended except for temporary compatibility needs.

Input parameters

Parameter	Data Type	Is it Required?	Description
`guid`	String	Yes	The unique entity GUID of the monitor you want to downgrade.
`monitor.runtime.runtimeType`	String	Yes	Set to empty string `""` to use legacy runtime.
`monitor.runtime.runtimeTypeVersion`	String	Yes	Set to empty string `""` to use legacy runtime.
`monitor.runtime.scriptLanguage`	String	Yes	Set to empty string `""` to use legacy runtime.

Sample request

mutation {
 syntheticsUpdateScriptBrowserMonitor(
 guid: "ENTITY_GUID"
 monitor: {
 runtime: { runtimeType: "", runtimeTypeVersion: "", scriptLanguage: "" }
 }
 ) {
 errors {
 description
 type
 }
 }
}

Sample response

A successful response returns null for errors:

{
 "data": {
 "syntheticsUpdateScriptBrowserMonitor": {
 "errors": null
 }
 }
}

If there are any issues downgrading the monitor runtime, the errors array will contain objects with description and type fields explaining what went wrong.

Delete a scripted browser monitor

When a scripted browser monitor is no longer needed, you can permanently remove it using the syntheticsDeleteMonitor mutation.

To delete a monitor, refer to the Delete Synthetic monitor section.

Create a scripted browser monitor .css-21sua1{background:none;border:none;width:0;padding:0;}

Input parameters

Sample request

Sample response

Update a scripted browser monitor

Input parameters

Sample request

Sample response

Upgrade a scripted browser monitor's runtime

Input parameters

Sample request

Sample response

Downgrade a scripted browser monitor's runtime

Important

Input parameters

Sample request

Sample response

Delete a scripted browser monitor

Create a scripted browser monitor