RP_APIGetDataFileCount: RP_APIGetDataFileCount
In RavenPack/r-api: RavenPack API to Self Service Platform

View source: R/RP_SelfServiceAPI_EndPoints.R

RP_APIGetDataFileCount

R Documentation

RP_APIGetDataFileCount

Description

Gets the count of the dataset for a time range described on payload. The datafile count endpoint allows you to find out how many rows a particular datafile will contain before actually generating it. In general it is a good idea to use this in order to determine if a particular datafile will be too large and will need to be broken up into smaller subsets. Please note: When requesting a count for a dataset defined with granular frequency, the count will be an exact count of the records that match in the time-range specified. When requesting a count for a dataset defined with daily frequency, the count is an estimate and has a margin of error typically less then 1

Usage

RP_APIGetDataFileCount(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.