RP_APIRequestDataFile: RP_APIRequestDataFile

View source: R/RP_SelfServiceAPI_EndPoints.R

RP_APIRequestDataFileR Documentation

RP_APIRequestDataFile

Description

The datafile endpoint allows a file to be generated for a particular dataset for any period from the year 2000 to present. Data may be retrieved in CSV or Excel format and may be compressed for transmission via HTTP. Note: There is a limitation of 50 million records for generating granular data and 10 million records for aggregated data.

Usage

RP_APIRequestDataFile(APIHandler, payload, datasetUUID)

Arguments

APIHandler

An API handler, created using RP_CreateAPIHandler.

payload

A string in JSON format with the request body parameters.

datasetUUID

A string with the dataset identifier.

Value

A list with the request token and the expected time.

Author(s)

Jose A. Guerrero-Colon


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