getFeaturedSummary: Retrieve featured summary reports.

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

Retrieve featured summary reports.

Description

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

Usage

getFeaturedSummary(product_ids, end_date, start_date, 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.
start_date	Character string or date object. Date of first ranks to be reported. Defaults to the last 31 days. See Details.
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 start_date and 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'.

The list of countries included in the request is included as an attribute.

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.