Create Synthetic Web Monitoring Job API

This page describes the API used to create and configure a Synthetic web monitoring job.

Create a Synthetic Job

Creates a new Synthetic web monitoring job with the specified JSON payload.

Resource URL 

POST /v1/synthetic/schedule

Request/Response Format

JSON

Example

Request
{
"scheduleRunConfigs": [
{
"rate": {
"value": 15,
"unit": "MINUTES"
},
"daysOfWeek": [
"SUN",
"WED",
"FRI",
"MON",
"THUR",
"SAT",
"TUES"
],
"timezone": "UTC"
}
],
"description": "appd1",
"appKey": "appKey",
"script": {
"contentType": "INLINE_PYTHON_3",
"script": "pageUrl = \"http://www.appdynamics.com\"\ndriver.get(pageUrl)\nassert \"AppDynamics\" in driver.title, \"Title should contain AppDynamics\""
},
"browserCodes": [
"Chrome"
],
"chromeVersions": [
"86"
],
"locationCodes": [
"M50"
],
"captureVisualMetrics": true,
"simulateMobileBrowser": false,
"networkProfile": {
"name": "Native",
"downloadKbps": 5000,
"uploadKbps": 1000,
"roundtripTimeMillis": 28,
"packetLossPercent": 0,
"isDefault": false
},
"timeoutSeconds": 30,
"performanceCriteria": {
"retestOnWarning": false,
"retestOnCritical": false,
"criterion": []
},
"composableConfig": {
"numBeforeConfirmedError": 0,
"resourceErrorDetection": {
"ignoreWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
},
"onlyWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
}
}
}
}
Response
{
"_id": "job_id",
"version": 1,
"scheduleRunConfigs": [
{
"rate": {
"value": 1,
"unit": "MINUTES"
},
"daysOfWeek": [
"WED",
"FRI",
"SUN",
"SAT",
"TUES",
"MON",
"THUR"
],
"timezone": "UTC"
}
],
"userEnabled": true,
"systemEnabled": true,
"type": "ALL_BROWSERS",
"rate": {
"value": 15,
"unit": "MINUTES"
},
"daysOfWeek": [
"WED",
"FRI",
"SUN",
"SAT",
"TUES",
"MON",
"THUR"
],
"timezone": "UTC",
"description": "https://appdynamics.com",
"appKey": "appKey",
"scheduleMode": "NONE",
"url": "https://appdynamics.com",
"browserCodes": [
"Chrome"
],
"chromeVersions": [
"86"
],
"locationCodes": [
"BOM",
"M50"
],
"failOnPageError": true,
"captureVisualMetrics": true,
"simulateMobileBrowser": false,
"networkProfile": {
"name": "Native",
"downloadKbps": 5000,
"uploadKbps": 1000,
"roundtripTimeMillis": 28,
"packetLossPercent": 0,
"isDefault": false
},
"timeoutSeconds": 15,
"state": {
"lastFireTime": "2022-04-06T05:57:16.000Z",
"nextFireTime": "2022-04-06T06:00:16.000Z"
},
"projectedUsage": {
"projectedDailyRuns": 2880,
"projectedMonthlyRuns": 86400
},
"performanceCriteria": {
"retestOnWarning": false,
"retestOnCritical": false,
"criterion": []
},
"composableConfig": {
"numBeforeConfirmedError": 0,
"resourceErrorDetection": {
"ignoreWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
},
"onlyWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
}
}
},
"created": "2022-04-05T05:30:36.426Z",
"updated": "2022-04-05T05:30:36.426Z"
}

Request Parameters

Parameter NameParameter TypeValueDescriptionMandatory Request
scheduleRunConfigs -No
rate -No
value number

Minutes: 1 - 60

Hours: 1 - 24

Days: "null"

No
unit StringMinutes, Hours, or DaysNo
daysOfWeek String "SUN", "MON", "TUES", "WED", "THUR", "FRI", "SAT" No
timeRange StringBetween hh:mm AM/PM to hh:mm AM/PMNo
timezone String "UTC" GMT +/-hh:mmNo
startTime Stringdd/mm/yyyy hh:mm AM/PMNo
endTime Stringdd/mm/yyyy hh:mm AM/PMNo
description StringJob nameName of the jobYes

appKey

String

Application key

You can get the application key from the Controller.

Navigate to User Experience > Browser Apps. The application key is listed next to the application name.

Yes
url String"null" or URL to monitor

The URL that you want to monitor.

When you use this parameter, the value of the script

Yes
script String

"null"

If you have a scripted job, specify the python-based selenium script used for simulating the user flow or behavior.

When you use this parameter, the value of the url

Yes
contentType String "null" or "INLINE_PYTHON_3"

If the url

If the script "INLINE_PYTHON_3"

Yes
script String "null" or Python script Python-based selenium script for the scripted jobsYes
credentialPlaceholders String
apiMetadata StringScript object of the web monitoring jobNo
browserCodes String

Use the following Synthetic internal browser codes:

  • Chrome: Chrome
  • Internet Explorer: IE11
  • Firefox: Firefox
  • Mobile: Chrome.DeviceEmulation
Yes
chromeVersions StringChrome browser version 86Yes
locationCodes String

Synthetic internal location codes of each agent location. See Location Codes.

Yes
captureVisualMetrics Booleantrue or false No
simulateMobileBrowser Booleantrue or false No

networkProfile

String"name": "Native", "downloadKbps": 5000, "uploadKbps": 1000, "roundtripTimeMillis": 28, "packetLossPercent": 0, "isDefault": falseNo

name

StringCustom, Pixel, iPad, iPhone SEName of the deviceNo

description

String

If the name is Custom: User agent

If the name field is not Custom: "null"

Mozilla/5.0 (Linux; Android 7.0; SAMSUNG SM-G950F Build/NRD90M) AppleWebKit/537.36 (KHTML, like Gecko) SamsungBrowser/5.2 Chrome/51.0.2704.106 Mobile Safari/537.36No
downloadKbps NumberNumberDownload bandwidth in kbpsNo
uploadKbps NumberNumberUpload bandwidth in kbpsNo
roundtripTimeMillis NumberNumberLatency in millisecondsNo
packetLossPercent Number0 - 100Packet loss percentageNo
isDefault Booleantrue or false No
timeoutSeconds Number5 - 300SecondsNo
performanceCriteria -No
retestOnWarning Booleantrue or false Re-test on warning eventNo
retestOnCritical Booleantrue or false Re-test on critical eventNo
criterion StringNo
composableConfig -You can use this parameter to configure:
  • Custom Retry
  • Availability Rules
No
numBeforeConfirmedError Number0, 1, 2, 3, 5, or 10Number of retriesNo
resourceErrorDetection -No
ignoreWhen -No
resourceUrlContains StringComma separated listList of resource URLsNo
resourceMimeType StringNo
onlyWhen -No
resourceUrlContains StringComma separated listList of resource URLsNo
resourceMimeType StringNo

Location Codes

Cloud LocationCodes
Azure
AmsterdamNET
San AntonioSAN
MelbourneASV
TorontoCAC
ChennaiSIC
AWS
MumbaiBOM
DublinDUB
FrankfurtFRA
Sao PauloGRU
Hong KongHON
AshburnIAD
SeoulICN
LondonLON
BoardmanM50
MilanMIL
MontrealMON
TokyoNRT
ParisPAR
San FranciscoSFO
SingaporeSIN
SydneySYD

Response Status Codes

CodeDescription
200Success
401Unauthorized
402Exceeded job limit
422Validation failure
429Throttled
500Internal server error