R/get_new_users.R

In reveneraR: Connect to Your 'Revenera' (Formerly 'Revulytics') Data

#' Get New Users by Product ID and Various Date Spans
#'
#' For a given period of time (a day, week, or month) Revenera' API
#' summarizes and returns the number of new users. With this function
#' you can return daily, weekly, or monthly new users for multiple
#' product ids.
#'
#' You can specify a start and end date but Revenera does not store
#' an indefinite period of historical data. In my experience this is
#' three years but I do not know if this varies on a product or client
#' level.
#'
#' It is not recommended that your username be stored directly in your
#' code. There are various methods and packages available that are more
#' secure; this package does not require you to use any one in particular.
#'
#' @param rev_product_ids A vector of Revenera product id's for which
#' you want new user data.
#' @param rev_date_type Level of aggregation, Revenera will accept
#' "day", "week", or "month".
#' @param rev_start_date Date formatted YYYY-MM-DD. Revenera may give
#' an error if you try to go back too far.
#' @param rev_end_date Date formatted YYYY-MM-DD.
#' @param rev_session_id Session ID established by the connection to
#' Revenera API. This can be obtained with revenera_auth().
#' @param rev_username Revenera username.
#'
#' @import dplyr
#' @importFrom magrittr "%>%"
#' @importFrom purrr "map_dfr"
#' @import httr
#' @import jsonlite
#'
#' @return Data frame with new users for each product id and
#' unique date within the range
#'
#' @export
#'
#' @examples
#' \dontrun{
#' rev_user <- "my_username"
#' rev_pwd <- "super_secret"
#' product_ids_list <- c("123", "456", "789")
#' start_date <- lubridate::floor_date(Sys.Date(), unit = "months") - months(6)
#' end_date <- Sys.Date() - 1
#' session_id <- revenera_auth(rev_user, rev_pwd)
#' monthly_new_users <- get_new_users(
#'   product_ids_list,
#'   "month",
#'   start_date,
#'   end_date,
#'   session_id,
#'   rev_user
#' )
#' }
#'
get_new_users <- function(rev_product_ids, rev_date_type, rev_start_date,
                          rev_end_date, rev_session_id, rev_username) {
  . <- NA # prevent variable binding note for the dot

  get_by_product <- function(x, rev_date_type) {
    request_body <- list(
      user = rev_username,
      sessionId = rev_session_id,
      productId = x,
      startDate = rev_start_date,
      stopDate = rev_end_date,
      dateSplit = rev_date_type,
      clientStatus = array("new")
    )

    request <- httr::RETRY("POST",
      url = paste0(
        "https://api.revulytics.com/",
        "reporting/generic/dateRange?responseFormat=raw"
      ),
      body = request_body,
      encode = "json",
      times = 4,
      pause_min = 10,
      terminate_on = NULL,
      terminate_on_success = TRUE,
      pause_cap = 5
    )

    check_status(request)

    request_content <- httr::content(request, "text", encoding = "ISO-8859-1")
    content_json <- jsonlite::fromJSON(request_content, flatten = TRUE)

    iteration_df <- as.data.frame(unlist(content_json$results)) %>%
      cbind(rownames(.)) %>%
      dplyr::rename(new_user_date = 2, new_users = 1) %>%
      dplyr::mutate(
        new_user_date = as.Date(substr(.data$new_user_date, 1, 10)),
        revenera_product_id = x
      )
    rownames(iteration_df) <- NULL
    return(iteration_df)
  }

  df <- purrr::map_dfr(rev_product_ids, get_by_product, rev_date_type)

  return(df)
}