revulytics_auth: Login and Obtain Revultyics API Session Id

Description Usage Arguments Details Value Examples

View source: R/revulytics_auth.R

Description

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

Usage

1
revulytics_auth(rev_username, rev_password)

Arguments

rev_username

Revulytics username.

rev_password

Revultyics password.

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

1
2
3
4
5
6
7
8
9
## 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)

revulyticsR documentation built on Dec. 5, 2020, 1:06 a.m.