QueueRankedBatch: Batch RSiteCatalyst API Requests
In blazickjoe/DataScienceLibrary: DKS R Functions

Description Usage Arguments

View source: R/QueueRankedBatch.R

This function batches out the ranked requests to the Adobe API in an effort to parallelize the requests and utilize the 8 slots available in the API. Note that batching by time period often outperforms running the same QueueTrended report.

QueueRankedBatch(reportsuite.id, date.from, date.to, metrics, elements,
  top = 5, segment.id = "", classification = c(), search = c(),
  selected = c(), batchBy = "search", rows = NA, batchLength = 5,
  queueUse = 6, pauseTime = 15, verboseQueue = F)

`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
`elements`	List of elements to include in the report
`top`	List of numbers to limit the number of rows to include (top X). eg. c(10,5)
`segment.id`	Id(s) of Adobe Analytics segment to retrieve the report for
`classification`	SAINT classification to use in place of first element. Need to specify element AND classification.
`search`	List of keywords for the first specified element - e.g. c("contact","about","shop"). search overrides anything specified using selected
`selected`	List of specific items (of the first element) to include in the report - e.g. c("www:home","www:search","www:about"). this only works for the first element (API limitation).
`batchBy`	Accepts "day", "week", "rows", "search", and "selected". Note when using "rows" top is overwritten by batchLength Note when using "search" or "selected" batchLength must be defined.
`rows`	Estimation of total number of rows.
`batchLength`	The number of "search", "selected", or "rows" to use in each batch.
`queueUse`	Set number of slots to use in queue before pausing.
`pauseTime`	Set the length of time to pause before attempting to submit another report. Should be the amount of time it takes to return 1 report.
`verboseQueue`	TRUE or FALSE to print queue status at each request.