QueueFallout: Run a Fallout Report

In randyzwitch/RSiteCatalyst: R Client for Adobe Analytics API V1.4

Description

A QueueFallout Report is a report that shows how visitors drop out as part of a specified path.

Usage

QueueFallout(reportsuite.id, date.from, date.to, metrics, element, checkpoints,
  segment.id = "", expedite = FALSE, interval.seconds = 5,
  max.attempts = 120, validate = TRUE, enqueueOnly = FALSE)

Arguments

reportsuite.id	Report suite id
date.from	Start date for the report (YYYY-MM-DD)
date.to	End date for the report (YYYY-MM-DD)
metrics	List of metrics to include in the report
element	Single pathed element (usually 'page')
checkpoints	Character vector of checkpoints in the fallout path (e.g. c("Home","Contact","Thank You"))
segment.id	Id(s) of Adobe Analytics segment to retrieve the report for
expedite	Set to TRUE to expedite the processing of this report
interval.seconds	How long to wait between attempts
max.attempts	Number of API attempts before stopping
validate	whether to submit report definition for validation before requesting the data.
enqueueOnly	only enqueue the report, don't get the data. returns report id, which you can later use to get the data

Details

Because of the Reporting API structure, this function first requests the report, then checks the reporting queue to see if the report is completed, and when the report returns as "done" pulls the report from the API. This checking process will occur up to the specified number of times (default 120), with a delay between status checks (default 5 seconds). If the report does not return as "done" after the number of tries have completed, the function will return an error message.

Value

Data frame or report id, if enqueueOnly is TRUE

Examples

## Not run: 

falloutpattern <- c("Home Page","Contact Page","Login Page")
queue_fallout_pages <- QueueFallout("your_report_suite",
                                    "2014-04-01",
                                    "2014-04-20",
                                    metric="pageviews",
                                    element="page",
                                    falloutpattern
                                    )
queued_report_id <- QueueFallout("your_report_suite",
                                    "2014-04-01",
                                    "2014-04-20",
                                    metric="pageviews",
                                    element="page",
                                    falloutpattern,
                                    enqueueOnly=TRUE
                                    )

## End(Not run)

randyzwitch/RSiteCatalyst documentation built on May 11, 2020, 3:05 p.m.