RP_APIGetDataSetPreview: RP_APIGetDataSetPreview
In RavenPack/r-api: RavenPack API to Self Service Platform
View source: R/RP_SelfServiceAPI_EndPoints.R
RP_APIGetDataSetPreview R 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.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/RP_SelfServiceAPI_EndPoints.R
| RP_APIGetDataSetPreview | R 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
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.