Monitoring API

• Monitor Administration

  • List Methods
  • Expand Methods

  • POSTCreate a Monitor/monitor/1.0
    Creates a new monitor and returns the monitor id of the newly created monitor. Name, interval, testScript and locations are required. Use the Get Monitoring Locations api to retrieve a list of monitoring locations.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    name		string	The name of the monitor
    description		string	A description of what this monitor is for
    interval	123451015203060	enumerated	How often the monitoring script will run for each of the locations
    testScript		string	The id of the test script that this monitor should run
    locations		string	A CSV list of locations that this monitor should run from. Ex: sanfrancisco,washingtondc or ["San Francisco, CA","Washington DC"]
    alertPolicy		string	The id of the alert policy that this monitor should run
    browser	CHROMEFFIEEMU	enumerated	Specifies the browser type that this monitor should use. Note: IE is available for Enterprise customers only
    emuDimensions		string	Specifies the emuDimensions in widthxheight format eg: 1440x1080
    active	truefalse	enumerated	Enables or disables this monitor from taking samples
    type	dnspingpopportsmtp	enumerated	Set to network monitor type such as 'dns'. See related settings below. Leave this blank for script-based monitors. Note: this interface will not allow you to test network monitor creation. Please use your API client.
    dnsSettings		object	A JSON object containing all DNS-related settings: {"timeout": int, "lookups": array}. The "lookups" array contains JSON objects with this format: {"lookupType": string ("A" or "AAAA"), "authoritative": boolean, "hostname": string, "dnsServer": string, "expectedIps": string of comma-separated IP addresses}
    pingSettings		object	A JSON object containing all PING-related settings: {"timeout": int, "host": string}.
    popSettings		object	A JSON object containing all POP-related settings: {"timeout": int, "server": string, "username": string, "password": string}.
    portSettings		object	A JSON object containing all PORT-related settings: {"timeout": int, "server": string, "port": int, "protocol": string ("tcp" or "udp"), "command": string, "expected_response": string, "data_format": string ("ascii" or "raw")}.
    smtpSettings		object	A JSON object containing all SMTP-related settings: {"timeout": int, "server": string, "email": string}.
    slaSettings		object	A JSON object containing SLA settings: {"uptime": float, "loadtime": float, "runningAvgDuration": int}. Setting 'runningAvgDuration' accepts values 5, 10, 15, 20 (minutes)

    
    
  • GETList Monitors/monitor/1.0
    Retrieves a list of all monitors associated with your account, along with information about each. The monitor id that is returned is used to make other api calls.
    
    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the monitor
    alertPolicy	string	The ID of the alerting policy associated with this monitor
    locations	array of strings	A list of monitoring locations that this monitor is run from
    script	object	The version, id and name of the script associated with this monitor
    description	string	The description of the monitor
    interval	int	How often this monitor runs, in minutes
    name	string	The name of this monitor
    lastSampleAt	ISO 8601 Date	The time of the last monitoring sample for this monitor
    active	bool	Describes whether this monitor is actively monitoring or not
    inMaintenanceWindow	bool	Whether this monitor is in a maintenance window or not
    browser	FF|CHROME|IE|EMU	Describes the type of browser that monitor is using, 'FF' for Firefox or 'CHROME' for Chrome, or 'IE' for Internet Explorer, or 'EMU' for Emulated browser
    deviceHeight	string	Describes the Height of the browser
    deviceWidth	string	Describes the Width of the browser
    type	string	The type of monitor ('RealBrowserUser', 'VirtualUser', 'dns')
    dnsSettings	object	DNS Settings for this monitor (if a dns monitor)

    
    
  • GETGet a Monitor/monitor/1.0/:monitorID
    Retrieves information for a specific monitor associated with your account. The monitor id that is returned is used to make other api calls.
    
    

    Input Variables:

    URL Variable	Value
    monitorID

    
    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the monitor
    alertPolicy	string	The ID of the alerting policy associated with this monitor
    locations	array of strings	A list of monitoring locations that this monitor is run from
    script	object	The version, id and name of the script associated with this monitor
    description	string	The description of the monitor
    interval	int	How often this monitor runs, in minutes
    name	string	The name of this monitor
    lastSampleAt	ISO 8601 Date	The time of the last monitoring sample for this monitor
    interval	int	How often this monitor runs
    active	bool	Describes whether this monitor is actively monitoring or not
    inMaintenanceWindow	bool	Whether this monitor is in a maintenance window or not
    browser	FF|CHROME|IE|EMU	Describes the type of browser that monitor is using, 'FF' for Firefox or 'CHROME' for Chrome, or 'IE' for Internet Explorer, or 'EMU' for Emulated browser
    deviceHeight	string	Describes the Height of the browser
    deviceWidth	string	Describes the Width of the browser
    type	string	The type of monitor ('RealBrowserUser', 'VirtualUser', 'dns')
    dnsSettings	object	DNS Settings for this monitor (if a dns monitor)

    
    
  • PUTUpdate A Monitor/monitor/1.0/:monitorID
    Change some or all of the parameters of an existing monitor. Requires the monitor ID retrieved from the List Monitors api.
    
    

    Input Variables:

    URL Variable	Value
    monitorID

    
    

    Parameter	Value	Type	Description
    name		string	The name of the monitor
    description		string	A description of what this monitor is for
    interval	123451015203060	enumerated	How often the monitoring script will run for each of the locations
    testScript		string	The id of the test script that this monitor should run
    locations		string	A CSV list of locations that this monitor should run from
    alertPolicy		string	The id of the alert policy that this monitor should run
    browser	CHROMEFFIEEMU	enumerated	Specifies the browser type that this monitor should use. Note: IE is available for Enterprise customers only
    emuDimensions		string	Specifies the emuDimensions in widthxheight format eg: 1440x1080
    active	truefalse	enumerated	Enables or disables this monitor from taking samples
    slaSettings		object	A JSON object containing SLA settings: {"uptime": float, "loadtime": float, "runningAvgDuration": int}. Setting 'runningAvgDuration' accepts values 5, 10, 15, 20 (minutes)

    
    
  • DELETEDelete a Monitor/monitor/1.0/:monitorID
    Deletes the given monitor, stopping it from monitoring and removing all its monitoring data.
    
    

    Input Variables:

    URL Variable	Value
    monitorID

    
    
    

• Sample Information

  • List Methods
  • Expand Methods

  • GETGet Samples/monitor/1.0/:monitorID/sample
    Returns all samples associated to this monitor for a given time period. This data is returned at a high level, which timing for the overall sample. To get the details for the specific sample, call the get raw sample data api. At a maximum, this api will return 2000 samples. If there are more than 2000 results returned, the 'more' field will be set to true and you can make another api call specifying an offset which would be equal to the number of results returned in the first api call plus the offset of that call.
    
    

    Input Variables:

    URL Variable	Value
    monitorID

    
    

    Parameter	Value	Type	Description
    startDate		string	An ISO 8601 formatted date string or datetime string representing the start date from which you wish to collect samples. Examples: 2012-03-02 or 2012-03-01T12:00
    endDate		string	An ISO 8601 formatted date string or datetime string representing the end date from which you wish to collect samples. Examples: 2012-03-02 or 2012-03-01T12:00
    offset		int	From which position in the return list you wish to start. At most, 2000 records will be returned.

    
    

    Output Variables:

    Variable	Possible Values	Description
    status	ERROR|WARNING|SUCCESS	ERROR indicates the sample contained an error,
    bytesReceived	int	The number of bytes received during this sample
    location	Possible values are returned from the 'Monitoring Agent Information' api	The locations that this monitor is running from
    startTime	ISO 8601 Date and time	The ISO 8601 formatted time string representing the time this sample was taken in GMT
    lineNumber	int	If this sample is an error, this is the line number that it errored on in the script
    duration	int	The number of ms that this sample took to run
    id	string	The id of this monitoring sample

    
    
  • GETGet Last Sample/monitor/1.0/:monitorID/lastsample
    Returns last sample associated to this monitor. This data is returned at a high level, which timing for the overall sample. To get the details for the specific sample, call the get raw sample data api.
    
    

    Input Variables:

    URL Variable	Value
    monitorID

    
    
    

    Output Variables:

    Variable	Possible Values	Description
    status	ERROR|WARNING|SUCCESS	ERROR indicates the sample contained an error,
    bytesReceived	int	The number of bytes received during this sample
    location	Possible values are returned from the 'Monitoring Agent Information' api	The locations that this monitor is running from
    startTime	ISO 8601 Date and time	The ISO 8601 formatted time string representing the time this sample was taken in GMT
    lineNumber	int	If this sample is an error, this is the line number that it errored on in the script
    duration	int	The number of ms that this sample took to run
    id	string	The id of this monitoring sample

    
    
  • GETGet Raw Sample Data/monitor/1.0/:monitorID/sample/:sampleID
    Retrieve the raw, HTTP Archive (HAR) data for a particular sample
    
    

    Input Variables:

    URL Variable	Value
    monitorID
    sampleID

    
    
    
  • GETGet Aggregate Sample Data/monitor/1.0/:monitorID/aggregate
    Retrieves the aggregated sample information for a given period of time. You can choose to aggregate the data for each hour or each day. This is more effecient than getting all the individual samples for a period of time and performing the aggregation yourself.
    
    

    Input Variables:

    URL Variable	Value
    monitorID

    
    

    Parameter	Value	Type	Description
    startDate		string	An ISO 8601 formatted date string or datetime string representing the start date from which you wish to collect samples. Examples: 2012-03-02 or 2012-03-01T12:00
    endDate		string	An ISO 8601 formatted date string or datetime string representing the end date from which you wish to collect samples. Examples: 2012-03-02 or 2012-03-01T12:00
    offset		int	From which position in the return list you wish to start. At most, 2000 records will be returned.
    frequency	dayhour	enumerated	Aggregation period
    groupBy	locationstep	enumerated	When selected, the data will be aggregated by the selected 'groupBy'

    
    

    Output Variables:

    Variable	Possible Values	Description
    count	int	The number of samples in this time period
    uptime	float	The uptime percentage for this time period
    min	int	The minimum value of the measurements for this time period
    max	int	The maximum value of the measurements for this time period
    date	ISO 8601 Date	The UTC hour or day of this aggregation period
    avg	float	The average of the values for this time period
    stdDev	float	The stdDev of values for this time period
    location	string	if groupBy location is selected, the particular location for these samples
    stepName	string	if groupBy step is selected, the step name for these samples
    stepNumber	int	if groupBy step is selected, the step number for these samples
    tp50	float	Load time 50th percentile, in milliseconds (available at a 'day' frequency)
    tp90	float	Load time 90th percentile, in milliseconds (available at a 'day' frequency)

    
    

• Monitor Summary Information

  • List Methods
  • Expand Methods

  • GETGet Summary/monitor/1.0/:monitorID/summary
    The monitor summary api returns all of the data that is found when looking at your list of monitors in the web portal. This includes things such as the average load time, sample count and uptime for the day, week, month or year, the last time an error occurred, and the last error message.
    
    

    Input Variables:

    URL Variable	Value
    monitorID

    
    
    

    Output Variables:

    Variable	Possible Values	Description
    name	string	The name of this monitor
    status	string	The monitor status: either 'Alerting', 'Warning', 'Scheduled', 'Active', 'Maintenance', 'Off'
    generalStatus	string	The general status of the monitor, is the monitor erroing or in success state
    lastSampleAt	ISO 8601 Date	When the last sample was taken
    lastSampleId	float	The ID for the last sample taken. This ID can be used with the sample or aggregate APIs
    lastSampleDuration	float	The duration of the last sample, in milliseconds
    lastSampleStatus	string	The last sample status of the monitor
    lastErrorAt	ISO 8601 Date	When the last error occured
    avgUptimeDay	float	The average uptime this day, as a percentage
    avgUptimeWeek	float	The average uptime for the current week, as a percentage
    avgUptimeMonth	float	The average uptime this month, as a percentage
    avgUptimeQuarter	float	The average uptime this quarter, as a percentage
    avgUptimeYear	float	The average uptime for the current year, as a percentage
    avgLoadtimeDay	float	The average load time this day, in milliseconds
    avgLoadtimeMonth	float	The average load time this month, in milliseconds
    avgLoadtimeQuarter	float	The average load time this quarter, in milliseconds
    avgLoadtimeYear	float	The average load time this year, in milliseconds
    sampleCountDay	int	The number of samples this day
    sampleCountWeek	int	The number of samples this week
    sampleCountMonth	int	The number of samples this month
    sampleCountYear	int	The number of samples this year
    tp50	float	Load time 50th percentile for the previous UTC day, in milliseconds
    tp90	float	Load time 90th percentile for the previous UTC day, in milliseconds

    
    

• Monitoring Agent Information

  • List Methods
  • Expand Methods

  • GETGet Monitoring Locations/monitor/1.0/locations
    Get a list of all monitoring locations available
    
    
    
  • GETGet IP addresses of Monitoring Location/monitor/1.0/:locationName/ip
    Retrieves IP addresses for given monitoring location
    
    

    Input Variables:

    URL Variable	Value
    locationName

    
    
    

• Monitoring Group Information

  • List Methods
  • Expand Methods

  • POSTCreate group/monitor/1.0/group/create/:groupName
    Create a group for given monitorIds
    
    

    Input Variables:

    URL Variable	Value
    groupName

    
    

    Parameter	Value	Type	Description
    monitor_ids		string	The ID of the monitors separated by comma. Ex: monitor_id1,monitor_id2

    
    

    Output Variables:

    Variable	Possible Values	Description
    group	string	The group name of the monitor
    monitor	string	The name of the monitor

    
    
  • PUTUpdate group/monitor/1.0/group/update/:groupName
    Update a group for a given monitorId
    
    

    Input Variables:

    URL Variable	Value
    groupName

    
    

    Parameter	Value	Type	Description
    monitor_ids		string	The ID of the monitors separated by comma. Ex: monitor_id1,monitor_id2

    
    

    Output Variables:

    Variable	Possible Values	Description
    group	string	The group name of the monitor
    monitor	string	The name of the monitor

    
    
  • DELETEDelete group/monitor/1.0/group/delete
    Delete a group for a given monitorId
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    monitor_ids		string	The ID of the monitors separated by comma. Ex: monitor_id1,monitor_id2