R/rah_metrics_extended.R

In civitch/Doingbuzz-Ahrefs: 'Ahrefs' API R Interface

#' Export additional metrics about the target, such as total number of referring domains, referring class C networks and referring IP addresses.
#'
#' @param target character string. Aim of a request: a domain, a directory or a URL
#' @param token character string. Authentication token. Should be available through enviromental variables
#'     after authentication with function \code{rah_auth()}
#' @param mode character string. Mode of operation: exact, domain, subdomains or prefix. See more in Details section
#' @param metrics character vector of columns to select. See more in Details section
#' @param limit integer. Number of results to return
#' @param order_by character vector of columns to sort on. See more in Details section
#' @param where character string - a condition created by \code{rah_condition_set()} function that generates proper
#'     \code{"where"} condition to satisfy. See more in Details section
#' @param having character string - a condition created by \code{rah_condition_set()} function that generates proper
#'     \code{"having"} condition to satisfy. See more in Details section
#'
#' @source \url{https://ahrefs.com/api/documentation}
#'
#' @details
#'     \strong{1. available metrics} - you can select which columns (metrics) you want to download and which one
#'     would be useful in filtering, \strong{BUT not all of them can always be used} in \code{"where"} &
#'     \code{"having"} conditions:
#'
#'     \tabular{lllll}{
#'     Column \tab Type \tab Where \tab Having \tab Description\cr
#'     backlinks           \tab int \tab - \tab - \tab Number of external backlinks found on the referring pages that link to the target.                                                  \cr
#'     refpages            \tab int \tab - \tab - \tab Number of external web pages containing at least one backlink that links to the target.                                             \cr
#'     pages               \tab int \tab - \tab - \tab Number of unique pages visited by the Ahrefs crawler on the target.                                                                 \cr
#'     valid_pages         \tab int \tab - \tab - \tab Number of unique pages with non 5xx HTTP code, visited by the Ahrefs crawler on the target.                                         \cr
#'     text                \tab int \tab - \tab - \tab Number of backlinks that use anchor texts.                                                                                          \cr
#'     image               \tab int \tab - \tab - \tab Number of backlinks that use image as an anchor.                                                                                    \cr
#'     nofollow            \tab int \tab - \tab - \tab Number of NoFollow backlinks that link to the target.                                                                               \cr
#'     dofollow            \tab int \tab - \tab - \tab Number of DoFollow backlinks that link to the target.                                                                               \cr
#'     redirect            \tab int \tab - \tab - \tab Number of redirects found that forward to the target.                                                                               \cr
#'     canonical           \tab int \tab - \tab - \tab Number of canonical backlinks that link to the target.                                                                              \cr
#'     alternate           \tab int \tab - \tab - \tab Number of alternate backlinks that link to the target.                                                                              \cr
#'     gov                 \tab int \tab - \tab - \tab Number of backlinks of all types (including images and NoFollow) found on web pages on governmental domains that link to the target.\cr
#'     edu                 \tab int \tab - \tab - \tab Number of backlinks of all types (including images and NoFollow) found on web pages on educational domains that link to the target. \cr
#'     rss                 \tab int \tab - \tab - \tab Number of RSS external links from the target.                                                                                       \cr
#'     html_pages          \tab int \tab - \tab - \tab Number of HTML pages the target link has.                                                                                           \cr
#'     links_internal      \tab int \tab - \tab - \tab Number of internal links found in the target.                                                                                       \cr
#'     links_external      \tab int \tab - \tab - \tab Number of external links found in the target.                                                                                       \cr
#'     refdomains          \tab int \tab - \tab - \tab Number of domains containing at least one backlink that links to the target.                                                        \cr
#'     refclass_c          \tab int \tab - \tab - \tab Number of referring class C networks that link to the target.                                                                       \cr
#'     refips              \tab int \tab - \tab - \tab Number of distinct IP addresses under a single network that link to the target.                                                     \cr
#'     linked_root_domains \tab int \tab - \tab - \tab Number of internal or external domains that are linked from the target.
#'     }
#'
#'     \strong{2. \code{"mode"}} parameter can take 4 different values that will affect how the results will be grouped.
#'
#' Example of URL directory with folder:
#'     \itemize{
#'       \item \strong{Example URL:} ahrefs.com/api/
#'       \item \strong{exact:} ahrefs.com/api/
#'       \item \strong{domain:} ahrefs.com/*
#'       \item \strong{subdomains:} *ahrefs.com/*
#'       \item \strong{prefix:} ahrefs.com/api/*
#'     }
#' Example of URL directory with subdomain:
#'     \itemize{
#'       \item \strong{Example URL:} apiv2.ahrefs.com
#'       \item \strong{exact:} apiv2.ahrefs.com/
#'       \item \strong{domain:} apiv2.ahrefs.com/*
#'       \item \strong{subdomains:} *apiv2.ahrefs.com/*
#'       \item \strong{prefix:} apiv2.ahrefs.com/*
#'     }
#'
#'    \strong{3. \code{"order_by"}} parameter is a character string that forces sorting of the results. Structure:
#'     \itemize{
#'       \item \strong{Structure:} "\code{column_name}:asc|desc"
#'       \item \strong{Single column example:} "first_seen:asc" ~ this sorts results by \code{first_seen}
#'       column in ascending order
#'       \item \strong{Multi column example:} "last_seen:desc,first_seen:asc" ~ this sorts results
#'           by 1) \code{last_seen} column in descending order, and next by 2) \code{first_seen} column in
#'           ascending order
#'     }
#'
#'     \strong{4. \code{"where"} & \code{"having"}} are \strong{EXPERIMENTAL} parameters of condition sets
#'         (character strings) that control filtering the results. To create arguments:
#'         \enumerate{
#'           \item use \code{rah_condition()} function to create a single condition, for example:
#'               \code{cond_1 <- rah_condition(column_name = "links", operator = "GREATER_THAN", value = "10")}
#'           \item use \code{rah_condition_set()} function to group single conditions into final condition
#'               string, for example: \code{fin_cond <- rah_condition_set(cond_1, cond_2)}
#'           \item provide final condition to proper report function as a parameter, for example:
#'               \code{RAhrefs::rah_metrics_extended(target = "ahrefs.com", token = "0123456789",
#'               mode = "domain", metrics = NULL, limit = 1000, where = fin_cond, order_by = "first_seen:asc")}
#'         }
#'
#' @return data frame
#' @export
#'
#' @family Ahrefs reports
#'
#' @examples
#' \dontrun{
#' # downloading
#' b <- RAhrefs::rah_metrics_extended(
#'   target   = "ahrefs.com",
#'   limit    = 2,,
#'   order_by = "backlinks:desc")
#' }
rah_metrics_extended <- function(
  target,
  token    = Sys.getenv("AHREFS_AUTH_TOKEN"),
  mode     = "domain",
  metrics  = NULL,
  limit    = 1000,
  order_by = NULL,
  where    = NULL,
  having   = NULL)
{
  data_list <- rah_downloader(
    target  = target,
    report  = "metrics_extended",
    token   = token,
    mode    = mode,
    metrics = metrics,
    limit   = limit,
    order_by = order_by,
    where    = where,
    having   = having)


  data_df <- data.frame(t(sapply(data_list, unlist)))
  return(data_df)
}

# b <- rah_metrics_extended(target = "ahrefs.com", limit = 10)
# str(b)