Check Request Status

Description

This function is called by other functions that submit a requests to revulytics API. It checks the status code returned and tells the user if there was an error code and exits the function.

Usage

check_status(request_obj)

Value

If status code is not 200, returns a message to console with appropriate error message and stops execution.

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

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.

Value

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

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)

## End(Not run)

Get All Categories and Events for a List of Product Ids

Description

Returns all of the unique categories and events (basic and advanced) for each product id.

Usage

get_categories_and_events(rev_product_ids, rev_session_id, rev_username)

Arguments

Details

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.

Value

Data frame with categories, events and event type by product id.

Examples

## Not run: 
rev_user <- "my_username"
rev_pwd <- "super_secret"
product_ids_list <- c("123", "456", "789")
session_id <- revulytics_auth(rev_user, rev_pwd)  
category_event <- get_categories_and_events(product_ids_list, session_id, rev_user)

## End(Not run)

Get Metadata on Client Ids for a List of Product Ids

Description

Returns metadata (what Revulytics calls "properties") for every Client Id installed during user-provided date range for all product Ids in a list.

Usage

get_client_metadata(
  rev_product_ids,
  rev_session_id,
  rev_username,
  product_properties_df,
  desired_properties,
  installed_start_date,
  installed_end_date
)

Arguments

Details

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.

This API call can only return 200 Client Ids at a time. It will take a long time to execute if you have many Client Ids, as the function will submit requests to the API repeatedly; this may even result in a timeout error from the server. In order to provide data for troubleshooting this function will write a message to the console after each call. It is recommended that you divert the console output to a text file. You can do this in multiple ways, including with the sink function (see example for how to do this).

For the same reason you are encouraged to break your request into smaller chunks using the install dates and/or splitting up your product Ids.

Value

Data frame with selected properties for each Client Id.

Examples

## Not run: 
rev_user <- "my_username"
rev_pwd <- "super_secret"
product_ids_list <- c("123", "456", "789")
session_id <- revulytics_auth(rev_user, rev_pwd)  
product_properties <- get_product_properties(product_ids_list, session_id, rev_user)
sink("output_filename.txt") 
sink(stdout(), type = "message")
client_metadata <- get_client_metadata(product_ids_list, session_id, rev_user,
product_properties, c("Property1", "Property2"), start_date, end_date)
sink()

## End(Not run)

Get Daily Property Values for All Clients for a List of Product Ids

Description

Returns the list of daily client properties for all the client Ids installed during a user provided date range for all the Product Ids.

Usage

get_daily_client_properties(
  rev_product_ids,
  rev_session_id,
  rev_username,
  product_properties_df,
  desired_properties,
  installed_start_date,
  installed_end_date,
  daily_start_date,
  daily_end_date
)

Arguments

Details

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.

This API call can only return 200 Client Ids at a time. It will take a long time to execute if you have many Client Ids, as the function will submit requests to the API repeatedly; this may even result in a timeout error from the server. In order to provide data for troubleshooting this function will write a message to the console after each call. It is recommended that you divert the console output to a text file. You can do this in multiple ways, including with the sink function (see example for how to do this).

For the same reason you are encouraged to break your request into smaller chunks using the install dates and/or splitting up your product Ids.

Value

Data frame with selected properties for each Client Id.

Examples

## Not run: 
rev_user <- "my_username"
rev_pwd <- "super_secret"
product_ids_list <- c("123", "456", "789")
session_id <- revulytics_auth(rev_user, rev_pwd)  
product_properties <- get_product_properties(product_ids_list, session_id, rev_user)
sink("output_filename.txt") 
sink(stdout(), type = "message")
daily_client_properties <- get_daily_client_properties(product_ids_list, session_id, rev_user,
product_properties, c("Property1", "Property2"), start_date, end_date,
daily_start_date = "01-01-2020", daily_end_date = "01-31-2020")
sink()

## End(Not run)

Get New 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 new users. With this function you can return daily, weekly, or monthly new users for multiple product ids.

Usage

get_new_users(
  rev_product_ids,
  rev_date_type,
  rev_start_date,
  rev_end_date,
  rev_session_id,
  rev_username
)

Arguments

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.

Value

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

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_new_users <- get_new_users(product_ids_list,
"month",
start_date,
end_date,
session_id,
rev_user)

## End(Not run)

Get All Properties for a List of Product Ids

Description

Returns all of the unique properties (standard and custom) for each product id by property category.

Usage

get_product_properties(rev_product_ids, rev_session_id, rev_username)

Arguments

Details

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.

Value

Data frame with properties and property attributes by product id.

Examples

## Not run: 
rev_user <- "my_username"
rev_pwd <- "super_secret"
product_ids_list <- c("123", "456", "789")
session_id <- revulytics_auth(rev_user, rev_pwd)  
product_properties <- get_product_properties(product_ids_list, session_id, rev_user)

## End(Not run)

Get Raw Data Files

Description

Retrieves a list of raw data file exports that are available for a list of product IDs and the download URL for each file.

Usage

get_raw_data_files(rev_product_ids, rev_session_id, rev_username)

Arguments

Details

Raw data files are an add-on service available through Revenera. If these files are available they can be downloaded manually from the user portal, or downloaded via R. This function uses the API to first retrieve the list of files, and then get the download URL for each file.

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.

Value

Data frame with available files and URLs.

Examples

## Not run: 
rev_user <- "my_username"
rev_pwd <- "super_secret"
product_ids_list <- c("123", "456", "789")
session_id <- revulytics_auth(rev_user, rev_pwd)  
files_df <- get_raw_data_files(product_ids_list, session_id, rev_user)
file_list <- dplyr::pull(files_df, var = file_name)
for (f in file_list){
  url <- dplyr::filter(files_df, file_name == f) %>% dplyr::pull(download_url)
  download.file(url, mode = "wb", destfile = "download_file_location.zip")
}

## End(Not run)

Login and Obtain Revultyics API Session Id

Description

A session must first be established before querying the API. This is done using your Revulytics username and password.

Usage

revulytics_auth(rev_username, rev_password)

Arguments

Details

It is not recommended that these values 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.

Value

A list with details on connection to the Revulytics API.

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)

## End(Not run)

Stop Function Quietly

Description

Quit a function execution without printing error messages. The idea came from a Stack Overflow answer https://stackoverflow.com/questions/14469522/stop-an-r-program-without-error.

Usage

stop_quietly()

Value

Exits a function.