RSiteCatalyst (version 1.4.16)

SubmitJsonQueueReport: Create Queue Report from JSON

Description

Generic interface to validate, queue and retrieve a report from the API

Usage

SubmitJsonQueueReport(report.description, interval.seconds = 5,
  max.attempts = 120, validate = TRUE, enqueueOnly = FALSE,
  format = "json")

Arguments

report.description

JSON report description

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

format

"csv" or "json"

Value

Data frame or report id, if enqueueOnly is TRUE

Details

This is a function for advanced users, for the case where a user feels that submitting a JSON request would be easier than using one of the pre-defined functions from RSiteCatalyst

Examples

# NOT RUN {
custom_report <- SubmitJsonQueueReport('valid Adobe Analytics API JSON string')

# }
# NOT RUN {
# }