parameter | value | type | default / required* | notes |
---|
nkey | | token | * | Session key or token. Automatically assigned (only if optional) or obtained via acct_login/acct_token call. |
engine | | enum (amchart) | amchart | |
type | | enum (avail, perf, uptime, rtime, ctime, ptime, xtime, dtime, ttime, dsize, xspeed, dspeed, probes, checks, errors, apdex, spi, audit) | * | Protocol to test. |
xtype | | enum (average, interval, hourofday, dayofweek) | average * | |
aggr | | enum (none, monitor, checkpoint, country, continent) | monitor * | |
acct | | string | | Account e-mail. If left empty, then the request is on behalf of the account that is logged in (nkey). |
name | | string (80) | | Name of monitor (rule). |
folder | | string (30) | | Name of folder of a monitor (empty string is top level folder). |
tags | | string | | Tag names, comma separated list. |
tags_req | | enum (any, all) | any | |
lang | | string (2) | en | Language, two chararters, following ISO 639. |
start_date | | date | | Starting date, format YYYY-MM-DD. |
end_date | | date | | End date, format YYYY-MM-DD. |
style | | enum (plain, macwidget, winapp, vistagadget, googlegadget) | plain | deprecated, ignored. |
color | | string (6) | | deprecated, ignored. |
fillcolor | | string (6) | | deprecated, ignored. |
bgcolor | | string (6) | | deprecated, ignored. |
height | | unsigned int | 400 | |
width | | unsigned int | 600 | |
legend | | enum (0, 1) | 1 | |
axis | | boolean | y | |
transparent | | boolean | n | |
errors | | enum (xml, png) | xml | |
base | | string (100) | http://www.watchmouse.com/ | deprecated, ignored. |
debug | | boolean | n | |
dummy | | unsigned int | | Dummy parameter to make the REST call unique and prevent caching. |
callback | | string | | Callback function for JSONP style calls. When this parameter is given, the result will be JSON instead of XML. |
view | | enum (xml, json) | xml | Specifies the desirable representation of the output (XML or JSON). HTTP Accept header can be used and has precedence. |