Monitor Data Fields

This topic describes the monitor configuration fields that are available through the AlertSite JSON API. You can use these fields when adding or editing monitors, and they are included in the API response when you query monitor information.

All field names and values are case-sensitive.

Note that the API returns all numeric values as strings:

{
  "interval": "15",
  "timeout": "60",
  ...
}

However, when adding or editing monitors you can use specify numeric values as either numbers or strings:

{
  "interval": 15,
  "timeout": "60"
}

 

Note: Some monitor configuration settings are not available through the API. See Limitations for a list of unavailable settings.

Field Name Description Supported for monitors...  
DéjàClick Selenium SoapUI API endpoint Other
billing_plancode AlertSite billing plan for the monitor. For example, UBM-A/A (not UBM - A/A:1:50). You can see your available plans in Profile > Plan Details (in AlertSite UXM) or Account > Account Summary (in AlertSite 1.0).

Cannot be changed in existing monitors.

When creating new monitors, make sure to use a valid plan code that supports this monitor type. When in doubt, check which plan is used by your existing monitors and use the same plan code.

+ + + + +
browser_type The browser used by DéjàClick monitors. Possible values:
  • CH – Google Chrome
  • FF – Mozilla Firefox
  • IE – Internet Explorer

Defaults to FF if not specified when adding the monitor. Cannot be changed in existing monitors.

+        
capture_level The Capture level option of DéjàClick, Selenium and SoapUI monitors. Possible values:
  • 0 – Disabled (default)
  • 1 – Error only
  • 2 – All actions/steps on error
  • 3 – All actions/steps
  • 4 – All events on error (DéjàClick only)
  • 5 – All events (DéjàClick only)
+ + + +  
check_fullpage_missing_objects The Alert if objects are missing or new option. Possible values:
  • "" (empty string) – No (default)
  • 1 – Yes
+       +
check_fullpage_object_sizes The Alert if object size changes option. Possible values:
  • "" (empty string) – No (default)
  • 1 – Yes
+       +
check_ssl_expiration_dates The Report expired SSL certificates option of Secure Web URL and Secure API endpoint monitors. Possible values:
  • Disabled
  • Expired – When expired
  • 1 Day – 1 day before expiration
  • 2 Days – 2 days before expiration
  • 7 Days – 7 days before expiration
  • 15 Days – 15 days before expiration
  • 30 Days – 30 days before expiration

Defaults to Expired if not specified when adding the monitor.

An empty string ("") in the Get Monitors response means Expired.

        +
continue_playback_on_timeout The Continue playback on timeout option of DéjàClick monitors. Possible values:
  • 0 – No (default)
  • 1 – Yes
+        
email Used for Roundtrip E-mail monitors. The email address used to send round trip emails.         +
enabled Monitor status:
  • y – Enabled
  • n – Disabled (default)
+ + + + +
fullpage_object_timeout The full page object timeout, in seconds. Used only if interval_fullpage is different from -1.

Possible values: 0 (no timeout), 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 45, 60, 75, 90, 120, 150, 180, 240, 300

+ +     +
home_location The ID of the primary monitoring location for the monitor. You can find the IDs of AlertSite’s global locations here. If you use private nodes, you can get their IDs by using the Get Locations operation.

In the Get Monitors response, 0 means the account’s default primary location.

+ + + + +
http_302_is_error The Report redirects (HTTP 301/302) as errors option. Possible values:
  • "" (empty string) – No (default)
  • 1 – Yes
      + +
http_401_is_error The Report authentication challenges (HTTP 401/403) as errors option. Possible values:
  • "" (empty string) – No (default)
  • 1 – Yes
      + +
http_caching The Use caching - Simulates a repeat visitor option. Possible values:
  • Disabled (default)
  • Enabled
        +
http_follow_redirects The Follow redirect option. Possible values:
  • y – Yes (default)
  • n – No
        +
http_method HTTP method. Possible values:
  • g – GET (default)
  • p – POST
  • h – HEAD
  • c – The HTTP method is specified in the request payload. This is used for PATCH, PUT, and DELETE requests, also for GET and POST requests with custom headers.

Note that AlertSite API does not support getting or setting the request headers and payload.

      + +
http_version HTTP version: 1.0 (default) or 1.1.         +
id Read-only. The monitor ID. + + + + +
interval The monitoring interval, in minutes.

Possible values: 1, 2, 3, 4, 5, 6, 10, 15, 20, 30, 60, 120.

+ + + + +
interval_fullpage How often to measure full page metrics (page including all images, CSS, script files, etc.) for the monitored site or transaction.

Possible values: -1 (disabled), 1, 2, 3, 4, 5, 6, 10, 15, 20, 60, 120.

This value must be the same as interval or a multiple of interval. For example, if interval is 10, interval_fullpage can be 10, 20, 30, 60, 120.

+       +
ip_address If resolve_dns is y, ip_address is read-only and returns the IP address that your site resolved to when the monitor was created.

If resolve_dns is n, ip_address must specify the IP address to monitor. url is not used in this case.

        +
keyword_match_invert The Finding this keyword is an error (Invert match) option. Possible values:
  • Disabled (default)
  • Enabled
      + +
keyword_match_type Specifies whether keyword_string contains plain text or a regular expression. Possible values:
  • Plain Text (default)
  • Regular Expression
      + +
keyword_string The word, phrase or regular expression to find on the monitored web page. Regular expressions must be specified as strings ("Hello.*There!") rather than regular expression literals (/Hello.*There!/).       + +
locations An array of monitoring locations used by the monitor. Each location is specified by ID and (in the Get Monitors response) by name. You can find the IDs of AlertSite’s global locations here. If you use private nodes, you can get their IDs by using the Get Locations operation.

When adding or editing monitors, locations should be used together with home_location. home_location is automatically considered part of the locations array, so there is no need to repeat it inside locations. For example, the following are equivalent:

{
  "home_location": 10,
  "locations": [
    { "id": 10 },
    { "id": 20 }
  ]
  ...
}
{
  "home_location": 10,
  "locations": [
    { "id": 20 }
  ]
  ...
}
+ + + + +
mode The monitoring mode used for the monitor:
  • G – Global Notify
  • I – Primary
  • R – Round Robin
  • U – SLA (MultiPOP)
  • V – Global Verify
+ + + + +
monitor_location_count The number of locations per interval when using rotated locations, or 0 if rotated locations are not used.

For example, to set the Global Verify mode with rotated locations and 2 locations per interval, use:

{
  "mode": "V",
  "home_location": 10,
  "locations": [
    { "id": 10 },
    { "id": 20 },
    { "id": 52 },
    { "id": 63 }
  ],
  "monitor_location_count": 2,
  ...
}

To disable rotated locations, set monitor_location_count to 0.

+ + + + +
name The monitor name. When adding or editing monitors, the name should not contain characters " ' \ + + + + +
notify_on_content_change The Alert on content change option. Possible values:
  • y – Yes
  • n – No (default)
+       +
notify_on_error Whether availability alerts are enabled for this monitor. Possible values: y, n.

If omitted when adding a monitor, defaults to the value specified in your account preferences (Profile > Account > AlertSite Preferences > Alerting > Enable Alerts?).

+   + + +
notify_on_fullpage_errors The Alert on page asset errors option. Used only if full page monitoring is enabled, that is, interval_fullpage is different from -1. Possible values:
  • "" (empty string) – No (default)
  • 1 – Yes
+       +
pop3_hostname The POP3 Server option of Roundtrip E-mail monitors. This is the address of the POP3 server that the mail will be read from.         +
port Custom port number used by the monitored site, or an empty string if a standard port is used (80 for HTTP, 443 for HTTPS).         +
realm_password The password for Basic authentication if the monitored site required it. For security purposes, existing passwords are returned as <hidden>.       + +
realm_userid The user name for Basic authentication if the monitored site required it.       + +
resolve_dns The Resolve DNS option. Possible values:
  • y – Yes (default). In this case AlertSite monitors the url, and ip_address returns the IP address that your site resolved to when the monitor was created.
  • n – No. In this case AlertSite monitors the specified ip_address instead of the url.
        +
script The contents of the DéjàClick script, Selenium JAR file or SoapUI XML project file. For DéjàClick and SoapUI monitors, this is the file contents as plain text with the JSON encoding applied. For Selenium monitors, this is the base64-encoded contents of the JAR file. See Add Monitor for examples of how this field is encoded.

The Get Monitor response includes this field only if the show_scripts=1 parameter is used.

+ + +    
site_type The monitor type. Possible values:
  • dejaclickDéjàClick monitor (real browser or mobile web)
  • email-imap – E-mail (IMAP) Server
  • email-pop – E-mail (POP) Server
  • email-round-trip – Roundtrip E-mail (POP/SMTP)
  • email-smtp – E-mail (SMTP) Server
  • ftp – FTP Server
  • ftp-ssl – FTP over SSL (FTPS)
  • name-server – Name Server
  • perfectoPerfecto Mobile monitor
  • ping – Server/Device Ping
  • security-scanSecurity monitor
  • selenium – Selenium monitor
  • serveragentServerAgent monitor
  • soapui – SoapUI API monitor
  • tcp – Simple TCP Connect
  • transaction
  • transaction-ssl
  • website – Web URL monitor
  • website-api – API endpoint monitor
  • website-ssl – Web URL monitor for https:// URLs
  • website-ssl-api – API endpoint monitor for https:// endpoints
+ + + + +
smtp_hostname The SMTP server address used by Roundtrip E-mail monitors to send the test message. If left blank, mail is sent through normal sendmail/mail routing.         +
step_timeout The Browser timeout option, in seconds. Possible values: 1 to 300. + +      
test_case The name of a SoapUI test case used by the monitor. Can be updated by the Edit Monitor operation.     +    
test_suite The name of a SoapUI test suite used by the monitor. Can be updated by the Edit Monitor operation.     +    
timeout The monitor timeout, in seconds, or the step timeout (for DéjàClick and Selenium monitor only).

Possible values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 45, 60, 75, 90, 120, 150, 180, 240, 300.

+ + + + +
traceroute_on_error The TCP traceroute on network error option. Possible values:
  • y – Yes (default)
  • n – No
  • l – Log only
+       +
transaction_steps_allowed Read-only. The maximum number of steps per DéjàClick transaction, Selenium script or SoapUI test allowed by your AlertSite billing plan. The limit is 5 in AlertSite Community and Pro, and 50 on most Enterprise plans. + + +    
url The URL to monitor.       + +

See Also

© 2017 SmartBear Software. All rights reserved.      Terms of Use · Privacy Policy