R/url_info.R

In aws.alexa: Client for the Amazon Alexa Web Information Services API

#' Get Information about a URL
#'
#' @param url String; Required; valid url
#' @param response_group String; Required; One of the following: RelatedLinks, Categories, Rank,
#' RankByCountry, UsageStats, AdultContent, Speed, Language,  OwnedDomains, LinksInCount, SiteData
#' Default is 'SiteData'. Multiple fields can be passed. They must be separated by comma.
#' @param \dots Additional arguments passed to \code{\link{alexa_GET}}.
#'
#' @return named list
#' @export
#' @references \url{https://docs.aws.amazon.com/AlexaWebInfoService/latest/ApiReference_UrlInfoAction.html}
#' @examples \dontrun{
#' url_info(url = "http://www.google.com")
#' }

url_info <- function(url = NULL, response_group = "SiteData", ...) {

   if (!is.character(url)) {
        stop("Must specify URL")
   }

   query <-  list(Action = "UrlInfo", Url = url, ResponseGroup = response_group)
   urlinfo_payload <- alexa_GET(query, ...)

   urlinfo_payload
}