RP_APIGetDataSetPreview: RP_APIGetDataSetPreview

View source: R/RP_SelfServiceAPI_EndPoints.R

RP_APIGetDataSetPreviewR Documentation

RP_APIGetDataSetPreview

Description

Gets a preview from a dataset. Please note: Currently this endpoint only supports datasets with “daily” frequency. The sample will contain up to five entities from the entities supported by the dataset, and a maximum of 10 days per entities. In addition, a rollup for the whole dataset is never returned in the preview.

Usage

RP_APIGetDataSetPreview(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 to preview.

Value

A data.table with the preview.

Author(s)

Jose A. Guerrero-Colon


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