st_reviews_by_rating_facets: Fetch Review Metrics by Rating from Sensor Tower's Facets API

In sensortowerR: Interface to 'Sensor Tower' Mobile App Intelligence API

Fetch Review Metrics by Rating from Sensor Tower's Facets API

Description

Retrieves review metrics broken down by star rating from Sensor Tower's new facets-based review endpoint. This wrapper targets '"/v1/facets/metrics?facets=reviews_by_rating"'.

Usage

st_reviews_by_rating_facets(
  app_id,
  breakdown = c("date", "review_rating"),
  start_date,
  end_date,
  date_granularity = NULL,
  regions = NULL,
  languages = NULL,
  review_keywords = NULL,
  review_sentiments = NULL,
  review_tags = NULL,
  search_terms = NULL,
  rating_filters = NULL,
  auth_token = NULL,
  verbose = FALSE
)

Arguments

app_id	Single iOS app ID or Android package name.
breakdown	Breakdown fields or a comma-separated breakdown string. Supported combinations are '"review_rating"', '"date,review_rating"', '"region,review_rating"', '"language,review_rating"', and '"app_version,review_rating"'.
start_date	Start date in 'YYYY-MM-DD' format or as 'Date'.
end_date	End date in 'YYYY-MM-DD' format or as 'Date'.
date_granularity	Optional date granularity. Required when 'breakdown' includes 'date'.
regions	Optional character vector of iOS region codes.
languages	Optional character vector of Android language codes.
review_keywords	Optional character vector of review-keyword filters.
review_sentiments	Optional character vector of sentiment filters.
review_tags	Optional character vector of review-tag filters.
search_terms	Optional character vector of content search terms.
rating_filters	Optional character vector or integer vector of star filters ('1' through '5').
auth_token	Optional. Character string. Your Sensor Tower API token. Defaults to environment variable 'SENSORTOWER_AUTH_TOKEN'.
verbose	Logical. If 'TRUE', prints the request URL with the auth token redacted.

Details

Validated against the live Sensor Tower API on March 17, 2026.

Value

A [tibble][tibble::tibble] containing fields such as 'review_rating', 'review_rating_count', 'review_rating_percentage', and 'review_rating_average'.

See Also

[st_facets_metrics()] for raw facets access

Examples

## Not run: 
reviews <- st_reviews_by_rating_facets(
  app_id = "553834731",
  breakdown = c("date", "review_rating"),
  start_date = "2024-01-01",
  end_date = "2024-01-07",
  date_granularity = "day",
  regions = "US"
)

## End(Not run)

sensortowerR documentation built on March 18, 2026, 5:07 p.m.