getReviewCounts: Retrieve review counts.

View source: R/getReviews.R

getReviewCountsR Documentation

Retrieve review counts.

Description

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

Usage

getReviewCounts(product_ids, q = NULL, country, author, version, 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.

country

One or more country iso codes. Defaults to all countries. See Details.

author

Character. Name of an author to filter reviews.

version

Character. One of more version numbers of an app to filter reviews on.

stars

Integer. Values of one to five to filter reviews on. Defaults to reviews with any number of stars.

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.

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 country argument, a complete list of supported languages can be found using getStoreData.

Value

A a list of six named vectors breaking down the review counts. Review counts are broken down by stars, versions, countries, product ids, languages, and tags.

See Also

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


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