rah_broken_links: Export the broken links and details of the referring pages,...

Description Usage Arguments Details Value Source See Also Examples

View source: R/rah_broken_links.R

Description

Export the broken links and details of the referring pages, such as anchor and page title.

Usage

1
2
3
rah_broken_links(target, token = Sys.getenv("AHREFS_AUTH_TOKEN"),
  mode = "domain", metrics = NULL, limit = 1000, order_by = NULL,
  where = NULL, having = NULL)

Arguments

target

character string. Aim of a request: a domain, a directory or a URL

token

character string. Authentication token. Should be available through enviromental variables after authentication with function rah_auth()

mode

character string. Mode of operation: exact, domain, subdomains or prefix. See more in Details section

metrics

character vector of columns to select. See more in Details section

limit

integer. Number of results to return

order_by

character vector of columns to sort on. See more in Details section

where

character string - a condition created by rah_condition_set() function that generates proper "where" condition to satisfy. See more in Details section

having

character string - a condition created by rah_condition_set() function that generates proper "having" condition to satisfy. See more in Details section

Details

1. available metrics - you can select which columns (metrics) you want to download and which one would be useful in filtering, BUT not all of them can always be used in "where" & "having" conditions:

Column Type Where Having Description
url_from string + + URL of the page where the backlink is found.
url_to string + + URL of the page the backlink is pointing to.
ahrefs_rank int + + URL Rating of the referring page.
domain_rating int - + Domain Rating of the referring domain.
ip_from string + + IP address of the referring page.
links_internal int + + Number of internal links found in the referring page.
links_external int + + Number of external links found in the referring page.
page_size int + + Size of the referring page, in bytes.
encoding string + + Character encoding of the referring page, for example "utf8" or "iso-8859-1" (Latin-1).
title string + + Title of the referring page.
language string + + Language of the referring page (ISO 639-1).
first_seen date + + Least recent date when the Ahrefs crawler was able to visit the backlink.
last_visited date + + Most recent date when the Ahrefs crawler was able to visit the backlink.
prev_visited date + + Second to the most recent date when the Ahrefs crawler was able to visit the backlink.
original boolean + + Indicates whether the backlink was present on the referring page when the Ahrefs crawler first visited it.
link_type string + + Either "href", "redirect", "frame", "form", "canonical", "rss", or "alternate".
redirect int + + For redirected links, the Redirect Code (3XX), zero otherwise.
nofollow boolean + + Indicates whether the backlink is NoFollow.
alt string + + Alternative text of the image backlink, if exists.
anchor string + + Anchor text of the backlink.
text_pre string + + Snippet before the anchor text.
text_post string + + Snippet after the anchor text.
broken_at date + + The date when the Ahrefs crawler thinks the link became broken.
http_code int + + The HTTP code for the Link URL.
error string + + The string indicating the nature of error (currently only "dns").
domain_to_ahrefs_top int - + Ahrefs rank of the external domain.
url_from_first_seen date + + Least recent date when the Ahrefs crawler was able to visit the referring page with backlink.

2. "mode" parameter can take 4 different values that will affect how the results will be grouped.

Example of URL directory with folder:

Example of URL directory with subdomain:

3. "order_by" parameter is a character string that forces sorting of the results. Structure:

4. "where" & "having" are EXPERIMENTAL parameters of condition sets (character strings) that control filtering the results. To create arguments:

  1. use rah_condition() function to create a single condition, for example: cond_1 <- rah_condition(column_name = "links", operator = "GREATER_THAN", value = "10")

  2. use rah_condition_set() function to group single conditions into final condition string, for example: fin_cond <- rah_condition_set(cond_1, cond_2)

  3. provide final condition to proper report function as a parameter, for example: RAhrefs::rah_broken_links(target = "ahrefs.com", token = "0123456789", mode = "domain", metrics = NULL, limit = 1000, where = fin_cond, order_by = "first_seen:asc")

Value

data frame

Source

https://ahrefs.com/api/documentation

https://ahrefs.com/api/documentation

See Also

Other Ahrefs reports: rah_ahrefs_rank, rah_anchors_refdomains, rah_anchors, rah_backlinks_new_lost_counters, rah_backlinks_new_lost, rah_backlinks_one_per_domain, rah_backlinks, rah_broken_backlinks, rah_domain_rating, rah_linked_anchors, rah_linked_domains_by_type, rah_linked_domains, rah_metrics_extended, rah_metrics, rah_pages_extended, rah_pages_info, rah_pages, rah_refdomains_by_type, rah_refdomains_new_lost_counters, rah_refdomains_new_lost, rah_refdomains, rah_refips, rah_subscription_info

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
## Not run: 
# creating single conditions for 'where' parameter
cond_1 <- RAhrefs::rah_condition(
   column_name = "first_seen",
   operator    = "GREATER_OR_EQUAL",
   value       = "2018-01-01",
   is_date     = TRUE)

cond_2 <- RAhrefs::rah_condition(
   column_name = "http_code",
   operator    = "EQUALS",
   value       = "404")

# joining conditions into one condition set
cond_where <- RAhrefs::rah_condition_set(cond_1, cond_2)

# downloading
b <- RAhrefs::rah_broken_links(
  target   = "ahrefs.com",
  limit    = 2,
  where    = cond_where,
  order_by = "domain_rating:desc")

## End(Not run)

RAhrefs documentation built on July 28, 2019, 9:03 a.m.