R/rl_assessment_id.R

In redlist: Interface to the IUCN Red List Data

#' IUCN Red List assessment
#'
#' Retrieves an assessment
#'
#' @param assessment_id Assessment ID
#' @return A tibble where each column represents a unique API response JSON key for the supplied `assessment_id`. 
#' The columns include key information about the Red List assessment, such as taxon details, category, year, and other relevant metadata.
#'
#' @examples
#' \dontrun{
#' rl_assessment_id(1425064)
#' }
#'
#' @export
rl_assessment_id <- function(assessment_id = 1425064) {
  suppressMessages(rl_check_api())

  base_url <- paste0("https://api.iucnredlist.org/api/v4/assessment/", assessment_id)
  ass_id <- perform_request(base_url = base_url) %>%
    httr2::resp_body_json()

  return(json_to_df(ass_id))

}