RP_APIGetDataSetJSON: RP_APIGetDataSetJSON

View source: R/RP_SelfServiceAPI_EndPoints.R

RP_APIGetDataSetJSONR Documentation

RP_APIGetDataSetJSON

Description

The JSON dataset endpoint allows data to be requested synchronously and in JSON format. A predefined dataset must be supplied and the fields property may be overriden. Please note: Currently this endpoint only supports datasets with “daily” frequency.

Usage

RP_APIGetDataSetJSON(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 data.table with the requested dataset.

Author(s)

Jose A. Guerrero-Colon


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