RP_APIGetFullAdhocJSON: RP_APIGetFullAdhocJSON
In RavenPack/r-api: RavenPack API to Self Service Platform
View source: R/RP_SelfServiceAPI_EndPoints.R
RP_APIGetFullAdhocJSON R Documentation
RP_APIGetFullAdhocJSON
Description
The JSON dataset endpoint allows data to be requested synchronously in JSON format and without having previously defined a dataset.
The endpoint provides similar parameters to the ones used when creating a dataset so that RavenPack Analytics data can be queried in a more adhoc way.
Please note: Currently this endpoint only supports datasets with “daily” frequency.
Usage
RP_APIGetFullAdhocJSON(APIHandler, payload)
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.
Details
Limitations: will show the top 500 entities (in terms of volume), max lookback window will be 366 days, and max time range will be 366 days.
In the case of a timeout, the response will be a generic bad-request HTTP 400 code specifying that the requested data is too large and to split the request into smaller chunks.
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_APIGetFullAdhocJSON | R Documentation |
RP_APIGetFullAdhocJSON
Description
The JSON dataset endpoint allows data to be requested synchronously in JSON format and without having previously defined a dataset. The endpoint provides similar parameters to the ones used when creating a dataset so that RavenPack Analytics data can be queried in a more adhoc way. Please note: Currently this endpoint only supports datasets with “daily” frequency.
Usage
RP_APIGetFullAdhocJSON(APIHandler, payload)
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. |
Details
Limitations: will show the top 500 entities (in terms of volume), max lookback window will be 366 days, and max time range will be 366 days. In the case of a timeout, the response will be a generic bad-request HTTP 400 code specifying that the requested data is too large and to split the request into smaller chunks.
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.