R/top_attackers.r

In hrbrmstr/mhn: Analyze and Visualize Data from Modern Honey Network Servers

#' Get top attackers
#'
#' @param hours_ago specify how long to go back for results (API default to \code{4})
#' @param limit number of results to return (API defaults to \code{1000})
#' @param api_key MHN API key. Will retrieve from the environment or one can
#'                be specified explicitly.
#' @return \code{list} with attacker data and query result metadata
#' @export
top_attackers <- function(hours_ago=NULL, limit=NULL,
                          api_key=mhn_api_key(),
                          api_url=mhn_base_url()) {

  params <- list(api_key=api_key)
  if (!is.null(hours_ago)) params$hours_ago <- hours_ago
  if (!is.null(limit)) params$limit <- limit

  req <- GET(api_url, path="api/top_attackers/", query=params)

  stop_for_status(req)

  fromJSON(content(req, as="text"))

}