GET /broken-backlinks

Servers

Query parameters

Name Type Required Description
where String No

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the select parameter).

ahrefs_rank_source: The strength of the referring domain's backlink profile compared to the other websites in our database, with rank #1 being the strongest.
type: integer

ahrefs_rank_target: The strength of the target domain's backlink profile compared to the other websites in our database, with rank #1 being the strongest.
type: integer

alt: The alt attribute of the link.
type: string nullable

anchor: The clickable words in a link that point to a URL.
type: string

class_c (5 units): The number of unique class_c subnets linking to the referring page.
type: integer

domain_rating_source: The strength of the referring domain's backlink profile compared to the others in our database on a 100-point scale.
type: float

domain_rating_target: The strength of the referring domain's backlink profile compared to the others in our database on a 100-point scale.
type: float

encoding: The character set encoding of the referring page HTML.
type: string

first_seen: The date the referring page URL was first discovered.
type: datetime

first_seen_link: The date we first found a backlink to your target on a given referring page.
type: datetime

http_code: The return code from HTTP protocol returned during the referring page crawl.
type: integer

http_code_target: The return code from HTTP protocol returned during the target page crawl.
type: integer nullable

http_crawl: The link was discovered without executing javascript and rendering the page.
type: boolean

ip_source: The referring domain IP address.
type: string nullable

is_alternate: The link with the rel=“alternate” attribute.
type: boolean

is_canonical: The link with the rel=“canonical” attribute.
type: boolean

is_content: The link was found in the biggest piece of content on the page.
type: boolean

is_dofollow: The link has no special nofollow attribute.
type: boolean

is_form: The link was found in a form HTML tag.
type: boolean

is_frame: The link was found in an iframe HTML tag.
type: boolean

is_homepage_link: The link was found on the homepage of a referring website.
type: boolean

is_image: The link is a regular link that has an image inside their href attribute.
type: boolean

is_nofollow: The link or the referring page has the nofollow attribute set.
type: boolean

is_non_html: The link points to a URL with non-HTML content.
type: boolean

is_redirect: The link pointing to your target via a redirect.
type: boolean

is_root_source: The referring domain name is a root domain name.
type: boolean

is_root_target: The target domain name is a root domain name.
type: boolean

is_rss: The link was found in an RSS feed.
type: boolean

is_sponsored: The link has the Sponsored attribute set in the referring page HTML.
type: boolean

is_text: The link is a standard href hyperlink.
type: boolean

is_ugc: The link has the User Generated Content attribute set in the referring page HTML.
type: boolean

js_crawl: The link was discovered after executing javascript and rendering the page.
type: boolean

languages: The languages listed in the referring page metadata or detected by the crawler to appear in the HTML.
type: array(string)

last_seen: The date we discovered that the link was lost.
type: datetime nullable

last_visited: The date we last re-crawled the referring page to verify the backlink is alive.
type: datetime

last_visited_target: The date we last re-crawled the target page to verify that it is broken.
type: datetime nullable

len_url_redirect: The number of redirect chain URLs.
type: integer

link_group_count: The number of backlinks that were grouped together based on the aggregation parameter. This field cannot be used with aggregation 'all'.
type: integer

link_type: The kind of the backlink.
type: string
enum: "redirect" "frame" "text" "form" "canonical" "alternate" "rss" "image"

linked_domains_source_domain: The number of unique root domains linked from the referring domain.
type: integer

linked_domains_source_page: The number of unique root domains linked from the referring page.
type: integer

linked_domains_target_domain: The number of unique root domains linked from the target domain.
type: integer

links_external: The number of external links from the referring page.
type: integer

links_internal: The number of internal links from the referring page.
type: integer

name_source: The complete referring domain name, including subdomains.
type: string

name_target: The complete target domain name, including subdomains.
type: string

page_size: The size in bytes of the referring page content.
type: integer

port_source: The network port of the referring page URL.
type: integer

port_target: The network port of the target page URL.
type: integer

positions: The number of keywords that the referring page ranks for in the top 100 positions.
type: integer

positions_source_domain: The number of keywords that the referring domain ranks for in the top 100 positions.
type: integer

powered_by: Web technologies used to build and serve the referring page content.
type: array(string)

redirect_code: The HTTP status code of a referring page pointing to your target via a redirect.
type: integer nullable

redirect_kind: The HTTP status codes returned by the target redirecting URL or redirect chain.
type: array(integer)

refdomains_source (5 units): The number of unique referring domains linking to the referring page.
type: integer

refdomains_source_domain (5 units): The number of unique referring domains linking to the referring domain.
type: integer

refdomains_target_domain (5 units): The number of unique referring domains linking to the target domain.
type: integer

root_name_source: The root domain name of the referring domain, not including subdomains.
type: string

root_name_target: The root domain name of the target domain, not including subdomains.
type: string

snippet_left: The snippet of text appearing just before the link.
type: string

snippet_right: The snippet of text appearing just after the link.
type: string

source_page_author: The author of the referring page.
type: string nullable

title: The html title of the referring page.
type: string

tld_class_source: The top level domain class of the referring domain.
type: string
enum: "gov" "edu" "normal"

tld_class_target: The top level domain class of the target domain.
type: string
enum: "gov" "edu" "normal"

traffic (10 units): The referring page's estimated monthly organic traffic from search.
type: integer

traffic_domain (10 units): The referring domain's estimated monthly organic traffic from search.
type: integer

url_from: The URL of the page containing a link to your target.
type: string

url_from_plain: The referring page URL optimized for use as a filter.
type: string

url_rating_source: The strength of the referring page's backlink profile compared to the others in our database on a 100-point scale.
type: float

url_redirect: The target redirecting URL or redirect chain.
type: array(url)

url_to: The URL the backlink points to.
type: string

url_to_plain: The target page URL optimized for use as a filter.
type: string

limit Integer No

The number of results to return.

protocol String No

The protocol of your target.

Possible values:

  • "both"
  • "http"
  • "https"

Default value: "both"

output String No

The output format.

Possible values:

  • "csv"
  • "json"
  • "xml"
  • "php"
target String Yes

The target of the search: a domain or a URL.

timeout Integer No

A manual timeout duration in seconds.

mode String No

The scope of the search based on the target you entered.

Possible values:

  • "exact"
  • "domain"
  • "prefix"
  • "subdomains"

Default value: "subdomains"

select String Yes

A comma-separated list of columns to return. See response schema for valid column identifiers.

offset Integer No

[Deprecates on 31 May 2024] Returned results will start from the row indicated in the offset value.

order_by String No

A column to order results by. See response schema for valid column identifiers.

aggregation String No

The backlinks grouping mode.

Possible values:

  • "1_per_domain"
  • "similar_links"
  • "all"

Default value: "similar_links"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.