GET /refdomains

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).

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

discovered_status: The reason the link was discovered during the last crawl: the page was crawled for the first time, the link was added to the page, or the link re-appeared after being removed.
type: string nullable
enum: "pagefound" "linkfound" "linkrestored"

dofollow_linked_domains: The number of unique root domains with dofollow links linked from the referring domain.
type: integer

dofollow_links: The number of links from the referring domain to your target that don't have the “nofollow” attribute.
type: integer

dofollow_refdomains (5 units): The number of unique domains with dofollow links to the referring domain.
type: integer

domain: A referring domain that has at least one link to your target.
type: string

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

drop_reason: The reason we removed the link from our index.
type: string nullable
enum: "manual" "noratingunused" "notop" "tooold" "oldunavailable" "rescursive" "duplicate" "nxdomain" "malformed" "blockedport" "disallowed" "unlinked"

first_seen: The date we first found a backlink to your target from the referring domain.
type: datetime

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

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_homepage_link: The link was found on the homepage of a referring website.
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_root_domain: The domain name is a root domain name.
type: boolean

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

is_ugc: The link has the User Generated Content attribute set in the referring page HTML.
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 your target lost its last live backlink for the referring domain.
type: datetime nullable

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

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

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

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

links_to_target: The number of backlinks from the referring domain to your target.
type: integer

lost_links: The number of backlinks lost from the referring domain for the selected time period.
type: integer

lost_reason: The reason the link was lost during the last crawl.
type: string nullable
enum: "removedfromhtml" "notcanonical" "noindex" "pageredirected" "pageerror" "lostredirect" "notfound"

new_links: The number of new backlinks found from the referring domain for the selected time period.
type: integer

noindex: The referring page has the noindex meta attribute.
type: boolean

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)

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

root_domain_name: The root domain name of the referring 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

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

traffic_page (10 units): The referring page'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_redirect: The destination of the redirecting target URL.
type: array(url)

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

limit Integer No

The number of results to return.

history String No

A time frame to add lost backlinks to the report. Choose between live (no history), since:<date> (history since a specified date), and all_time (full history). The date should be in YYYY-MM-DD format.

Default value: "all_time"

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.

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.