RP_APIDownloadFullHistory: RP_APIDownloadFullHistory

In RavenPack/r-api: RavenPack API to Self Service Platform

RP_APIDownloadFullHistory

Description

This function downloads the full archive of RavenPack Analytics. This function is normally used for bulk loading the archive into a database. Files downloaded are yearly zip files containing monthly CSV files, up to the end of the prior month, relative to today.

Usage

RP_APIDownloadFullHistory(
  APIHandler,
  outFolderPath = "~/Downloads",
  onlyCompany = TRUE,
  flatfile_package = NULL
)

Arguments

APIHandler	An API handler, created using RP_CreateAPIHandler.
outFolderPath	The local folder to store the downloaded archive files.
onlyCompany	TRUE as default. Whether to download only analytics for companies or for all type of entities. This parameter will only be used on 'rpa' product.
flatfile_package	Unique identifier for the flat-file package. Only required for 'edge' product.

Value

TRUE if the operation succeeds. An ERROR otherwise. As output a set of zip files will be downloaded in the output folder indicated as parameter.

Author(s)

Maria Gomez

RavenPack/r-api documentation built on July 30, 2022, 9:56 p.m.