getReviews: Retrieve review reports.

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

Retrieve review reports.

Description

getReviews provides access to detailed review data from the appFigures web API

Usage

getReviews(product_ids, q = NULL, page = 1, count = 25,
  lang = NULL, author = NULL, country, version, stars,
  sort = c("date", "country", "stars"), start_date, end_date, curlHandle,
  verbose = FALSE, orgJSON = FALSE)

Arguments

product_ids	Numeric. A vector of appFigures-assigned product ids. Defaults to all products in the account.
q	Character. Only return reviews matching this character string.
page	Integer. Page number. Defaults to one.
count	Integer. The number of reviews to return. Any number between 1 and 500 is valid. Defaults to 25.
lang	Character. Short language code to translate reviews into. See Details.
author	Character. Name of an author to filter reviews.
country	One or more country iso codes. Defaults to all countries. See Details.
stars	Integer. Values of one to five to filter reviews on. Defaults to reviews with any number of stars.
sort	Character. How to sort the resulting reviews. Choose from "date", "country", or "stars". Defaults to "date".
start_date	Character string or date object. Date of first ranks to be reported. Defaults to the last 31 days. See Details.
end_date	Character string or date object. Date of last ranks to be reported. Defaults to today. 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.
versions	Character. One of more version numbers of an app to filter reviews on.

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'.

Regarding the lang and country arguments, a complete list of supported languages can be found using getStoreData.

Also, since the results are paginated, the returned data frame has an attached attribute called 'header', which provides data on the total number of reviews available, the current page number, and the total number of pages (given 'count' = xx).d

Value

A data frame containing the requested review report.

See Also

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

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