R/get_user_metrics.R

In briandconnelly/numerous: Interact with the Numerous API

#' Get a list of a user's metrics
#'
#' @param user_id The ID of the user to get metrics info for. If one is not
#' provided, the current user's ID is used.
#'
#' @return A list containing information about the user's metrics
#' @importFrom assertthat assert_that is.string
#' @importFrom httr content
#' @export
#'
#' @examples
#' \dontrun{
#' library(numerous)
#' u <- get_user_metrics(user_id = "321654987654321")
#' }
get_user_metrics <- function(user_id=get_numerous_user())
{
    assert_that(is.string(user_id))
    
    response <- numerous_GET(path=paste("users", user_id, "metrics", sep='/'))
    
    # TODO: handle pagination?
    rval <- content(response)$metrics
    lapply(rval, function(x) { class(x) <- c("NumerousMetric", "list"); x })
}