Data API / DataForSEO / Backlinks

Page Intersection

The pages linking to several target URLs at once, rather than the domains. ⚠️ targets is an object keyed by position and takes full URLs, not bare domains. Each row carries page_intersection and a summary per target. The domain-level equivalent is post_dataforseo_backlinks_domain_intersection_live, which is the one to reach for first.

Parameters

No path, query, or header parameters.

Request body

targetsobjectRequired
domains, subdomains or webpages to get links for required field you can set up to 20 domains, subdomains or webpages a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://) example: "targets": { "1": "http://planet.postgresql.org/", "2": "http://gborg.postgresql.org/" }
exclude_targetsstring[]Optional
domains, subdomains or webpages you want to exclude optional field you can set up to 10 domains, subdomains or webpages if you use this array, results will contain the referring pages that link to targets but don’t link to exclude_targets example: "exclude_targets": [ "bbc.com", "https://www.apple.com/iphone/*", "https://dataforseo.com/apis/*"]
backlinks_status_typestringOptional
set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics for your targets; possible values: all – all backlinks will be returned and counted; live – backlinks found during the last check will be returned and counted; lost – lost backlinks will be returned and counted; default value: live
filtersarrayOptional
array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, , in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["1.rank",">","80"] [["2.page_from_rank",">","55"], "and", ["1.original","=","true"]] [["1.first_seen",">","2017-10-23 11:31:45 +00:00"], "and", [["1.acnhor","like","%seo%"],"or",["1.text_pre","not_like","%seo%"]]] The full list of possible filters is available here.
order_bystring[]Optional
results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting type example: ["rank,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["domain_from_rank,desc","page_from_rank,asc"]
offsetintegerOptional
offset in the results array of the returned backlinks optional field default value: 0 if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks
limitintegerOptional
the maximum number of returned backlinks optional field default value: 100 maximum value: 1000
internal_list_limitintegerOptional
maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: attributes domain_from_platform_type default value: 10 maximum value: 1000
include_subdomainsbooleanOptional
indicates if the subdomains of the targets will be included in the search optional field if set to false, the subdomains will be ignored default value: true
include_indirect_linksbooleanOptional
indicates if indirect links to the targets will be included in the results optional field if set to true, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page if set to false, indirect links will be ignored default value: true
exclude_internal_backlinksbooleanOptional
indicates if internal backlinks from subdomains to the target will be excluded from the results optional field if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target if set to false, internal links will be included in the result default value: true
intersection_modestringOptional
indicates whether to intersect backlinks optional field use this field to intersect or merge results for the specified URLs possible values: all, partial all – results are based on all backlinks; partial – results are based on the intersecting backlinks only; default value: all
rank_scalestringOptional
defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank values are displayed on a 0–100 scale one_thousand — rank values are displayed on a 0–1000 scale default value: one_thousand learn more about how this parameter works and how ranking metrics are calculated in this Help Center article
tagstringOptional
user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/backlinks/page_intersection/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "targets": {},
  "exclude_targets": [
    "<string>"
  ],
  "backlinks_status_type": "<string>",
  "filters": "<string>",
  "order_by": [
    "<string>"
  ],
  "offset": 0,
  "limit": 0,
  "internal_list_limit": 0
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array returned with an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
status_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
targetsobjectOptional
targets from a POST array
total_countintegerOptional
total amount of results relevant the request
items_countintegerOptional
the number of results returned in the items array
itemsstring[]Optional
contains relevant backlinks and referring domains data
page_intersectionobjectOptional
contains data on pages that link to the corresponding targets specified in the POST array data is provided in separate objects corresponding to pages specified in the targets object
1string[]Optional
contains data on a referring page that links to the corresponding target from the POST array field name varies in the range from 1 to 20 according to the number of domains, subdomains or pages in the targets object
typestringOptional
type of element = ‘backlinks_page_intersection’
domain_fromstringOptional
domain referring to the target domain or webpage
url_fromstringOptional
URL of the page where the backlink is found
url_from_httpsbooleanOptional
indicates whether the referring URL is secured with HTTPS if true, the referring URL is secured with HTTPS
domain_tostringOptional
domain the backlink is pointing to
url_tostringOptional
URL the backlink is pointing to
url_to_httpsbooleanOptional
indicates if the URL the backlink is pointing to is secured with HTTPS if true, the URL is secured with HTTPS
tld_fromstringOptional
top-level domain of the referring URL
is_newbooleanOptional
indicates whether the backlink is new if true, the backlink was found on the page last time our crawler visited it
is_lostbooleanOptional
indicates whether the backlink was removed if true, the backlink or the entire page was removed
backlink_spam_scoreintegerOptional
spam score of the backlink learn more about how the metric is calculated on this help center page
rankintegerOptional
backlink rank rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article
page_from_rankintegerOptional
page rank of the referring page page_from_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article
domain_from_rankintegerOptional
domain rank of the referring domain indicates the rank of the domain at the time our crawler last saw the backlink; domain_from_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article
domain_from_platform_typestring[]Optional
platform types of the referring domain possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization
domain_from_is_ipbooleanOptional
indicates if the domain is IP if true, the domain functions as an IP address and does not have a domain name
domain_from_ipstringOptional
IP address of the referring domain
domain_from_countrystringOptional
ISO country code of the referring domain
page_from_external_linksintegerOptional
number of external links found on the referring page
page_from_internal_linksintegerOptional
number of internal links found on the referring page
page_from_sizeintegerOptional
size of the referring page, in bytes example: 63357
page_from_encodingstringOptional
character encoding of the referring page example: utf-8
page_from_languagestringOptional
language of the referring page in ISO 639-1 format example: en
page_from_titlestringOptional
title of the referring page
page_from_status_codeintegerOptional
HTTP status code returned by the referring page example: 200
first_seenstringOptional
date and time when our crawler found the backlink for the first time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
prev_seenstringOptional
previous to the most recent date when our crawler visited the backlink in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
last_seenstringOptional
most recent date when our crawler visited the backlink in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
item_typestringOptional
link type possible values: anchor, image, link, meta, canonical, alternate, redirect
attributesstring[]Optional
link attributes of the referring links example: nofollow
dofollowbooleanOptional
indicates whether the backlink is dofollow if false, the backlink is nofollow
originalbooleanOptional
indicates whether the backlink was present on the referring page when our crawler first visited it
altstringOptional
alternative text of the image this field will be null if backlink type is not image
anchorstringOptional
anchor text of the backlink
text_prestringOptional
text snippet before the anchor text
text_poststringOptional
snippet after the anchor text
semantic_locationstringOptional
indicates semantic element in HTML where the backlink is found you can get the full list of semantic elements here examples: article, section, summary
links_countintegerOptional
number of identical backlinks found on the referring page
group_countintegerOptional
indicates total number of backlinks from this domain for example, if mode is set to one_per_domain, this field will indicate the total number of backlinks coming from this domain
is_brokenbooleanOptional
indicates whether the backlink is broken if true, the backlink is pointing to a page responding with a 4xx or 5xx status code
url_to_status_codeintegerOptional
status code of the referenced page if the value is null, our crawler hasn’t yet visited the webpage the link is pointing to example: 200
url_to_spam_scoreintegerOptional
spam score of the referenced page if the value is null, our crawler hasn’t yet visited the webpage the link is pointing to learn more about how the metric is calculated on this help center page
url_to_redirect_targetstringOptional
target url of the redirect target page the redirect is pointing to
is_indirect_linkbooleanOptional
indicates whether the backlink is an indirect link if true, the backlink is an indirect link pointing to a page that either redirects to url_to, or points to a canonical page
indirect_link_pathstring[]Optional
indirect link path indicates a URL or a sequence of URLs that lead to url_to
typestringOptional
indirect link type possible values: redirect, canonical
status_codeintegerOptional
HTTP status code of the URL
urlstringOptional
indirect link URL
summaryobjectOptional
contains the page intersections summary
intersections_countintegerOptional
total number of intersections