Get the account details for who is linked to the given API key

Description

uptimerobot.account.details returns a list or a vector with the account details connected to the given api key.

Usage

uptimerobot.account.details(api.key, unlist = FALSE)

Arguments

Value

A list or a vector with the account details.

Author(s)

Gabriele Baldassarre

Examples

## Not run: 
# Let's assume the api.key is available into the environment variable KEY
api.key <- Sys.getenv("KEY", "")

# Returns details as a list
details.list <- uptimerobot.account.details(api.key)

# Returns details as a vector
details.num <- uptimerobot.account.details(api.key, unlist = TRUE)

## End(Not run)

Delete an alert contact

Description

uptimerobot.contact.delete removes an alert contanct, unlinking from all the registered monitors.

Usage

uptimerobot.contact.delete(api.key, id)

Arguments

Value

The function returns TRUE in case success. An error is thrown otherwise.

Author(s)

Gabriele Baldassarre

Examples

## Not run: 
 # Let's assume the api.key is available into the environment variable KEY
 api.key <- Sys.getenv("KEY", "")

 # Delete the contact with id=12345678
 if(uptimerobot.contact.delete(api.key, 12345678){
   message("Alert contact successfully deleted!")
 }

## End(Not run)

Add a new alert contact

Description

uptimerobot.contact.new creates a new alert contact with the given properties.

Usage

uptimerobot.contact.new(api.key, type, value, friendly.name)

Arguments

Details

The alert contacts are whom to be notified when the monitor goes up/down.

The index lookup keys and values are available on the Uptimerobot API page on https://uptimerobot.com/api

Value

The function returns the ID of the newly created contact in case success. An error is thrown otherwise.

Author(s)

Gabriele Baldassarre

See Also

uptimerobot.contacts, uptimerobot.contact.delete

Examples

## Not run: 
 # Let's assume the api.key is available into the environment variable KEY
 api.key <- Sys.getenv("KEY", "")
 # Create a new contact and get the ID
 contact.new <- uptimerobot.contact.new(api.key, type = "email", value = "foo@bar.com", "John Doe")

 # Get informations about this new contact
 contact.detail <- uptimerobot.contacts(api.key, contacts = contact.new)

## End(Not run)

Get general informations about the alert contacts

Description

uptimerobot.contacts extracts a dataset with general informations for a set of contacts used to be alert in case of up/down of the given monitors.

Usage

uptimerobot.contacts(api.key, contacts = NULL, limit = 50, offset = 0,
  fields = uptimerobot.fields("contact")$typical)

Arguments

Details

The alert contacts are whom to be notified when the monitor goes up/down.

If a vector of contact IDs is not given, the function will return data for all the available contacts.

The API uses pagination and returns no more than 50 contacts on each page. Use limit and offset to set a different number of monitors to get on each page and to move between pages. Leave default values to get all the data.

Value

A dataset with general informations about the contacts.

Author(s)

Gabriele Baldassarre

See Also

uptimerobot.monitors

Examples

## Not run: 
# Let's assume the api.key is available into the environment variable KEY
api.key <- Sys.getenv("KEY", "")

# Returns all the contacts with a default set of attributes
contacts.df <- uptimerobot.contacts(api.key)

# Returns all the contacts and all the attributes
contacts.full.df <- uptimerobot.contacts(api.key, fields=uptimerobot.fields("contact")$full))

# Returns only the two contacts with ID: 1234, 5678
contacts.df <- uptimerobot.contacts(api.key, c("1234", "5678"))

## End(Not run)

Get a list of the available fields for various endpoints

Description

uptimerobots.fields returns a list of vectors of available fields for commodity uses. Use it to avoid manually typing long list of fields in vectors or comma-delimited strings when used in various endpoints.

Usage

uptimerobot.fields(type)

Arguments

Details

Use the type parameter to choose which set of fields to return in a list of vectors. These endpoints are currently supported: monitor and contact.

Value

The function returns a list of 3 elements which in turn contains a vector of available fields for a given set each. The returned elements are:

1. typical returns a typical set of fields, used in most situations;

2. full returns the full set of available fields, including passwords and other potentially confidential data;

3. compact return a minimal set of fields.

Author(s)

Gabriele Baldassarre

See Also

uptimerobot.monitors, uptimerobot.contacts

Get contacts informations for one or more monitors

Description

uptimerobot.monitor.contacts return a dataset with all the alert contacts that will be triggered when a log is collected for the given monitors IDs.

Usage

uptimerobot.monitor.contacts(api.key, monitors, limit = 50, offset = 0)

Arguments

Details

The API uses pagination and returns no more than 50 monitors on each page. Use limit and offset to set a different number of monitors to get on each page and to move between pages. Leave default values to get all the data.

Value

A dataset with the alert contacts.

Author(s)

Gabriele Baldassarre

See Also

uptimerobot.monitors, uptimerobot.monitor.logs, uptimerobot.monitor.responses

Examples

## Not run: 
# Let's assume the api.key is available into the environment variable KEY
api.key <- Sys.getenv("KEY", "")

# Returns all the monitors IDs. Since the function always return a data.frame
# (even if you ask only for a column), you have to reference the column to get a character vector.
monitors.id <- uptimerobot.monitors(api.key, fields="id")$id

# Returns all the contacts registered for the given monitors
logs.df <- uptimerobot.monitor.contacts(api.key, monitors=monitors.id)

## End(Not run)

Delete a monitor

Description

uptimerobot.monitor.delete remove a monitor and all existing statistics of it.

Usage

uptimerobot.monitor.delete(api.key, id)

Arguments

Value

The function returns TRUE in case success. An error is thrown otherwise.

Author(s)

Gabriele Baldassarre

Examples

## Not run: 
 # Let's assume the api.key is available into the environment variable KEY
 api.key <- Sys.getenv("KEY", "")

 # Create a monitor and get its monitor.id
 monitor.id <- uptimerobot.monitor.new(api.key,
   friendly.name="Open Analytics",
   url="https://gabrielebaldassarre.com", type="http"
 )

 # Change the friendly name of the monitor
  if(uptimerobot.monitor.edit(api.key,
     monitor.id,
     friendly.name="Open Analytics - gabrielebaldassarre.com"
  ){
   message("Monitor has been successfully edited!")
 }

 # Delete the just-made monitor
 if(uptimerobot.monitor.delete(api.key, monitor.id){
   message("Monitor has been successfully deleted!")
 }

## End(Not run)

Edit a monitor

Description

uptimerobot.monitor.edit edits the properties for an existing monitor.

Usage

uptimerobot.monitor.edit(api.key, id, friendly.name = NULL, url = NULL,
  activate = TRUE, subtype = NULL, port = NULL, interval = NULL,
  keyword.type = NULL, keyword.value = NULL, HTTP.username = NULL,
  HTTP.password = NULL, alert.contacts = NULL)

Arguments

Details

If a property has not to be updated, just omit it from the parameters or set to NA. To erase the value of a property, set it to an empty string, ie "", instead (not NA or NULL!).

The type of a monitor can not be edited (like changing a HTTP monitor into a Port monitor).

The alert contacts are whom to be notified when the monitor goes up/down.

Multiple alert contact IDs can be sent in a character vector or in a data frame. If you pass alert contact IDs in a vector, each element must be formatted in the form <id>_<threshold>_<recurrence> (note the underscores). If you prefer to format it as a data.frame, it must have these three columns: id, threshold, recurrence, numeric or integer. Order of the columns doesn't matter.

Please note that thresholds and recurrences can be omitted (default to zero) and, as they are only available in the Pro Plan, they are always 0 in the Free Plan.

Value

The function returns TRUE in case success. An error is thrown otherwise.

Author(s)

Gabriele Baldassarre

Examples

## Not run: 
 # Let's assume the api.key is available into the environment variable KEY
 api.key <- Sys.getenv("KEY", "")

 # Create a monitor and get its monitor.id
 monitor.id <- uptimerobot.monitor.new(api.key,
   friendly.name="Open Analytics",
   url="https://gabrielebaldassarre.com", type="http"
 )

 # Change the friendly name of the monitor
  if(uptimerobot.monitor.edit(api.key,
     monitor.id,
     friendly.name="Open Analytics - gabrielebaldassarre.com"
  ){
   message("Monitor has been successfully edited!")
 }

 # Delete the just-made monitor
 if(uptimerobot.monitor.delete(api.key, monitor.id){
   message("Monitor has been successfully deleted!")
 }

## End(Not run)

Get log records for one or more monitors

Description

uptimerobot.monitor.logs return a dataset with all logged messages for the given monitors IDs.

Usage

uptimerobot.monitor.logs(api.key, monitors, limit = 50, offset = 0)

Arguments

Details

The API uses pagination and returns no more than 50 monitors on each page. Use limit and offset to set a different number of monitors to get on each page and to move between pages. Leave default values to get all the data.

Value

A dataset with the log events for the given monitors.

Author(s)

Gabriele Baldassarre

See Also

uptimerobot.monitors, uptimerobot.monitor.responses, uptimerobot.monitor.contacts

Examples

## Not run: 
# Let's assume the api.key is available into the environment variable KEY
api.key <- Sys.getenv("KEY", "")

# Returns all the monitors IDs. Since the function always return a data.frame
# (even if you ask only for a column), you have to reference the column to get a character vector.
monitors.id <- uptimerobot.monitors(api.key, fields="id")$id

# Returns all the log events for the given monitors
logs.df <- uptimerobot.monitor.logs(api.key, monitors=monitors.id)

## End(Not run)

Add a new monitor

Description

uptimerobot.monitor.new creates a new monitor with the given properties.

Usage

uptimerobot.monitor.new(api.key, friendly.name, url, type, subtype = NULL,
  port = NULL, interval = 5, keyword.type = NULL, keyword.value = NULL,
  HTTP.username = NULL, HTTP.password = NULL, alert.contacts = NULL)

Arguments

Details

The alert contacts are whom to be notified when the monitor goes up/down.

Multiple alert contact IDs can be sent in a character vector or in a data frame. If you pass alert contact IDs in a vector, each element must be formatted in the form <id>_<threshold>_<recurrence> (note the underscores). If you prefer to format it as a data.frame, it must have these three columns: id, threshold, recurrence, numeric or integer. Order of the columns doesn't matter.

Please note that thresholds and recurrences can be omitted (default to zero) and, as they are only available in the Pro Plan, they are always 0 in the Free Plan.

Value

A numeric with the ID of the newly created monitor in case of success. An error is thrown otherwise.

Author(s)

Gabriele Baldassarre

Examples

## Not run: 
 # Let's assume the api.key is available into the environment variable KEY
 api.key <- Sys.getenv("KEY", "")

 # Create a monitor and get its monitor.id
 monitor.id <- uptimerobot.monitor.new(api.key,
   friendly.name="Open Analytics",
   url="https://gabrielebaldassarre.com", type="http"
 )

 # Change the friendly name of the monitor
  if(uptimerobot.monitor.edit(api.key,
     monitor.id,
     friendly.name="Open Analytics - gabrielebaldassarre.com"
  ){
   message("Monitor has been successfully edited!")
 }

 # Delete the just-made monitor
 if(uptimerobot.monitor.delete(api.key, monitor.id){
   message("Monitor has been successfully deleted!")
 }

## End(Not run)

Reset a monitor

Description

uptimerobot.monitor.reset remove all the statistics and logs associated to a monitor ID.

Usage

uptimerobot.monitor.reset(api.key, id)

Arguments

Value

The function returns TRUE in case success. An error is thrown otherwise.

Author(s)

Gabriele Baldassarre

Examples

## Not run: 
 # Let's assume the api.key is available into the environment variable KEY
 api.key <- Sys.getenv("KEY", "")

# Get a list of all available monitors, and take the first id
monitors.id <- uptimerobot.monitors(api.key, fields="id")[1,1]

 # Reset the stats for that monitor
 uptimerobot.monitor.reset(api.key, monitor.id)


## End(Not run)

Get response times for one or more monitors

Description

uptimerobot.monitor.responses returns a dataset with all the response times for the given monitors IDs.

Usage

uptimerobot.monitor.responses(api.key, monitors, limit = 50, offset = 0)

Arguments

Details

The API uses pagination and returns no more than 50 monitors on each page. Use limit and offset to set a different number of monitors to get on each page and to move between pages. Leave default values to get all the data.

Value

A dataset with the response times for the given monitors.

Author(s)

Gabriele Baldassarre

See Also

uptimerobot.monitors, uptimerobot.monitor.logs, uptimerobot.monitor.contacts

Examples

## Not run: 
# Let's assume the api.key is available into the environment variable KEY
api.key <- Sys.getenv("KEY", "")

# Returns all the monitors IDs. Since the function always return a data.frame
# (even if you ask only for a column), you have to reference the column to get a character vector.
monitors.id <- uptimerobot.monitors(api.key, fields="id")$id

# Returns all the ping events for the given monitors
logs.df <- uptimerobot.monitor.responses(api.key, monitors=monitors.id)

## End(Not run)

Get general informations about monitors

Description

uptimerobots.monitors.responses return a dataset with general informations for a set of monitors.

Usage

uptimerobot.monitors(api.key, monitors = NULL, types = NULL,
  statuses = NULL, search = NULL, summary = list(), limit = 50,
  offset = 0, fields = uptimerobot.fields("monitor")$typical)

Arguments

Details

If a vector of monitor is not given, the function will return data for all the available monitors.

summary parameter expect a lists of three named logic values that set which columns of additional statistics for each monitor must be added to output dataset for each available monitor. These are summary values only, as the instances are obtained using a set of dedicated functions.

1. response.times set to TRUE to add a column with the number of pings with response times available for the monitor to the output. These values can be queried using uptimerobot.monitor.responses function.

2. log.records set to TRUE to add a column with the number of log entries recorded for the monitor to the output. These records can be queried using uptimerobot.monitor.logs function.

3. alert.contacts set to TRUE to add a column with the number of alert contacts binded to the monitor to the output. Detailed informations about these contacts can be queried using uptimerobot.monitor.contacts function.

You may just add the elements you want to include into the list, as they default to FALSE if missing. Set an empty list to exclude all the summary statistics from the output.

The API uses pagination and returns no more than 50 monitors on each page. Use limit and offset to set a different number of monitors to get on each page and to move between pages. Leave default values to get all the data.

Value

A dataset with general informations about the given monitors

Author(s)

Gabriele Baldassarre

See Also

uptimerobot.monitor.responses, uptimerobot.monitor.logs, uptimerobot.monitor.contacts

Examples

## Not run: 
# Let's assume the api.key is available into the environment variable KEY
api.key <- Sys.getenv("KEY", "")

# Returns all the  monitors with a default set of attributes
monitors.df <- uptimerobot.monitors(api.key)

#' # Returns all the monitors of 'keyword' type
monitors.kwd..df <- uptimerobot.monitors(api.key, type="keyword")

# Returns all the monitors and all the attributes
monitors.full.df <- uptimerobot.monitors(api.key, fields=uptimerobot.fields("monitor")$full))

# Returns only the two monitors with ID: 1234, 5678
monitors.df <- uptimerobot.monitors(api.key, c("1234", "5678"))

## End(Not run)