Get a user's ratings

Retrieve a user's media ratings

Usage

user_ratings(
  user = "me",
  type = c("movies", "seasons", "shows", "episodes"),
  rating = NULL,
  extended = c("min", "full"),
  limit = NULL
)

Source

user_ratings() wraps endpoint /users/:id/ratings/:type/:rating.

Arguments

user

character(1): Target username (or slug). Defaults to "me", the OAuth user. Can also be of length greater than 1, in which case the function is called on all user values separately and the result is combined.

type

character(1): Either "shows" or "movies". For season/episode-specific functions, values seasons or episodes are also allowed.

rating

integer(1) [NULL]: Optional rating between 1 and 10 to filter by.

extended

character(1): Either "min" (API default) or "full". The latter returns more variables and should generally only be used if required. See vignette("tRakt") for more details.

limit

integer(1) [NULL]: Number of items to return. If NULL (default), all items are returned.

Value

A tibble(). If the function has a limit parameter (defaulting to 10), this will be the (maximum) number of rows of the tibble. If there are no results (or the API is unreachable), an empty tibble() is returned.

See also

Other user data: user_collection(), user_comments(), user_history(), user_likes(), user_network(), user_profile(), user_stats(), user_watched(), user_watchlist()

Examples

if (FALSE) { # \dontrun{
user_ratings(user = "jemus42", "shows")
user_ratings(user = "sean", type = "movies")
} # }