GetReport: Get EnQueued Report by report ID

Description Usage Arguments Details Value Examples

View source: R/GetReport.R

Description

Get a single report by report id, this allow asynchronous way of getting reports.

Usage

1
2
GetReport(report.id, interval.seconds = 10, max.attempts = 3,
  print.attempts = TRUE, format = "json", page = 0)

Arguments

report.id

report id that's returned by QueueTrended and other functions while used with enqueueOnly parameter set to TRUE

interval.seconds

How long to wait between attempts

max.attempts

Number of API attempts before stopping

print.attempts

Print each attempt for fetching data

format

"csv" or "json"

page

Page Number of Resuts (QueueDataWarehouse only)

Details

This is a function for advanced users, after you've enqueued multiple reports and want to get one of them when it's ready.

Value

Data frame

Examples

1
2
3
4
5
6
## Not run: 

custom_report <- GetReport(12345678)


## End(Not run)

RSiteCatalyst documentation built on Nov. 6, 2019, 5:09 p.m.