reveneraR (version 1.0.1)

get_users: Get Users by Product ID, Type, and Various Date Spans

Description

For a given period of time (a day, week, or month) Revenera's API summarizes and returns the number of active users. With this function you can return daily, weekly, or monthly active users for multiple product ids.

Usage

get_users(
  rev_product_ids,
  user_type,
  rev_date_type,
  rev_start_date,
  rev_end_date,
  lost_days = 30,
  lost_reported = "dateLastSeen",
  group_by = "clientId",
  optional_json = ""
)

Value

Data frame with active users for each product id and unique date within the range

Arguments

rev_product_ids

A vector of Revenera product id's for which you want active user data.

user_type

One of "active," "new", or "lost."

rev_date_type

Level of aggregation, Revenera will accept "day", "week", or "month".

rev_start_date

Date formatted YYYY-MM-DD. Revenera may give an error if you try to go back too far.

rev_end_date

Date formatted YYYY-MM-DD.

lost_days

Required for lost users, the number of consecutive days of inactivity before a client is considered lost.

lost_reported

Required for lost users, should the lost date be the first day of inactivity ("dateLastSeen") or date client is considered lost ("dateDeclaredLost").

group_by

Optional parameter, clientId by default, but can be changed to a different custom property that Revenera would use to group the data.

optional_json

Optional JSON text to add to the request body for things like global filters.

Details

You can specify a start and end date but Revenera does not store an indefinite period of historical data.

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.

The optional_json parameter is available so that other optional arguments can be added to the api request. This will require the user to consult the API documentation. See README for an example.

Examples

if (FALSE) {
rev_user <- "my_username"
rev_pwd <- "super_secret"
logout(rev_user, rev_pwd)
Sys.sleep(30)
revenera_auth(rev_user, rev_pwd)
product_ids_list <- c("123", "456", "789")
start_date <- lubridate::floor_date(Sys.Date(), unit = "months") - months(6)
end_date <- Sys.Date() - 1
global_filter <- paste0(
  ",\"globalFilters\":{\"licenseType\":",
  "{\"type\":\"string\",\"value\":\"purchased\"}}"
)
monthly_active_users <- get_users(product_ids_list,
  "active",
  "month",
  start_date,
  end_date,
  optional_json = global_filter
)
}