R/pardot_visitors.R

Defines functions pardot_visitors

Documented in pardot_visitors

#' Retrieve Pardot Visitors
#'
#' Make a call to the Pardot API and returns the visitors matching the specified criteria parameters. 
#'
#' @param ... Comma separated list of parameter name and parameter value pairs. Parameter names are not quoted. 
#'   Allowed parameter names are created_after, created_before, id_greater_than, name, update_before, 
#'   updated_after, only_identified, prospect_ids.
#' @param verbose Verbose output. See pardot_client(). 
#' @return A data frame. See http://developer.pardot.com/kb/object-field-references/#visitor.
#' @examples
#' \dontrun{
#' set_credentials("your-username", "your-password", "your-user-key")
#' df <- pardot_visitors()
#' df <- pardot_visitors(created_after = 'yesterday', only_identified = 'true') }
#' @export pardot_visitors
#' @import pryr

pardot_visitors <- function(..., verbose = 0) {
    # Evaluate parameters in the context of the parent environment,
    # combine parameters to a querystring e.g. param1=value1&param2=value2&...
    dots <- lapply(pryr::named_dots(...), function(p) {
        eval(p, parent.frame())
    })
    request_pars <- paste(paste(names(dots), unlist(dots), sep = "="), collapse = "&")
    pardot_client("visitor", "query", request_pars = request_pars, verbose = verbose)  
}
jmurray0568/pardot4 documentation built on May 27, 2019, 2 a.m.