revulyticsR (version 0.0.3)

get_active_users: Get Active Users by Product ID and Various Date Spans

Description

For a given period of time (a day, week, or month) Revulytics' 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_active_users(
  rev_product_ids,
  rev_date_type,
  rev_start_date,
  rev_end_date,
  rev_session_id,
  rev_username
)

Arguments

rev_product_ids

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

rev_date_type

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

rev_start_date

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

rev_end_date

Date formatted YYYY-MM-DD.

rev_session_id

Session ID established by the connection to Revulytics API. This can be obtained with revulytics_auth().

rev_username

Revulytics username.

Value

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

Details

You can specify a start and end date but Revulytics 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.

Examples

# NOT RUN {
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 <- revulytics_auth(rev_user, rev_pwd)  
monthly_active_users <- get_active_users(product_ids_list,
"month",
start_date,
end_date,
session_id,
rev_user)
# }