getFeaturedCounts: Retrieve featured count reports.

In appfigures/afapi: An interface to the appFigures web API

Retrieve featured count reports.

Description

getFeaturedCounts provides access to detailed featured data from the appFigures web API

Usage

getFeaturedCounts(product_ids, end_date, count = 5, show_empty = FALSE,
  granularity = c("weekly", "daily"), curlHandle, verbose = FALSE,
  orgJSON = FALSE)

Arguments

product_ids	Numeric. A vector of appFigures-assigned product ids. Defaults to all account products.
end_date	Character string or date object. Date of last ranks to be reported. Defaults to today. See Details.
count	Integer. Max number of entries to show. Defaults to five.
show_empty	Logical. If set to TRUE, this call will return the last count periods whether or not they have data. Defaults to FALSE.
granularity	Character. Either "weekly" or "daily". Defaults to "weekly".
curlHandle	Provide an instance of the CURLHandle-class from the RCurl package. The default will create a curl handle specific to the function call.
verbose	Logical. Should details of the web request print to the console? Defaults to FALSE.
orgJSON	Logical. Should the JSON string be returned without being converted to R objects? Defaults to FALSE.

Details

For end_date, if the supplied argument can be interepreted as a date or POSIX object, any hour, minute, or second is ignored. If a string is supplied, it should have the format: 'yyyy-MM-dd'.

Value

A list of dataframes, one for each product id.

See Also

Official documentation: http://docs.appfigures.com/api/reference/v2/featured.

appfigures/afapi documentation built on Nov. 13, 2022, 9:27 a.m.