R/in_links.R

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

#' Sites linking to the site
#'
#'
#' @param url  String; Required; valid url
#' @param start index of result at which to start; default = 0
#' @param count Number of results to return for this request; Max = 20; Default = 20
#' @param \dots Additional arguments passed to \code{\link{alexa_GET}}.
#'
#' @return data.frame with two columns: title (site hostname) and url (specific url)
#'
#' @export
#' @references \url{https://docs.aws.amazon.com/AlexaWebInfoService/latest/ApiReference_SitesLinkingInAction.html}
#' @examples \dontrun{
#' in_links(url = "google.com")
#' }

in_links <- function(url = NULL, start = 0, count = 20, ...) {

  if (!is.character(url)) {
    stop("Please specify a valid url")
  }

  query <-  list(Action = "SitesLinkingIn", ResponseGroup = "SitesLinkingIn",
                                        Url = url, Start = start, Count = count)

  insite_links_payload <- alexa_GET(query, ...)

  res <- bind_rows(lapply(insite_links_payload$Response$SitesLinkingInResult$Alexa$SitesLinkingIn,
  	                                  function(x) c(title = x$Title, url =x$Url)))

  res
}