RSiteCatalyst (version 1.4.16)

QueuePathing: Run a Pathing report

Description

A QueuePathing Report is a report that shows how often visitors go from Page A to Page B to Page C on site.

Usage

QueuePathing(reportsuite.id, date.from, date.to, metric, element, pattern,
  top = 1000, start = 1, 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)

metric

Single metric to include in the report (usually 'pageviews')

element

Single pathed element (usually 'page')

pattern

Character vector of items in the path (up to 3) use "::anything::" as a wildcard. For example c("Home","::anything::","::anything::") will return all paths that start with the home page, c("::anything::","Home","::anything::") will return the previous and next pages from the home page, and c("::anything::","::anything::","Home") will return the two previous pages leading to the home page.

top

Number of rows to return (defaults to 1000)

start

Start row if you do not want to start at #1

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

Value

Data frame

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.

Examples

# NOT RUN {
pathpattern <- c("Home Page","::anything::","::anything::","::anything::")
queue_pathing_pages <- QueuePathing("your_report_suite",
                                    "2014-04-01",
                                    "2014-04-20",
                                    metric="pageviews",
                                    element="page",
                                    pathpattern
                                    )
enqueued.report.id <- QueuePathing("your_report_suite",
                                    "2014-04-01",
                                    "2014-04-20",
                                    metric="pageviews",
                                    element="page",
                                    pathpattern,
                                    enqueueOnly=TRUE
                                    )
# }
# NOT RUN {
# }