データ API / DataForSEO / Backlinks
Backlinks
The individual inbound links to one target, one row per link. Returns total_count, items_count, items and a search_after_token for paging - use that rather than offset past the first few pages. mode and custom_mode control grouping, backlinks_status_type selects live, lost or all. For counts rather than rows use post_dataforseo_backlinks_summary_live; for the linking domains grouped, post_dataforseo_backlinks_referring_domains_live.
パラメータ
パス・クエリ・ヘッダーのパラメータはありません。
リクエストボディ
targetstring必須domain, subdomain or webpage to get backlinks for required field a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://)
modestring任意results grouping type optional field possible grouping types: as_is – returns all backlinks one_per_domain – returns one backlink per domain one_per_anchor – returns one backlink per anchor default value: as_is
custom_modeobject任意detailed results grouping type optional field use this object to get a specific number of backlinks per field if you use custom_mode, then mode will be ignored example: "custom_mode": {"field": "domain", "value": 100}
fieldstring任意valueinteger任意filtersarray任意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: =, , in, not_in, like, not_like, ilike, not_ilike, regex, not_regex, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["rank",">","80"] [["page_from_rank",">","55"], "and", ["dofollow","=",true]] [["first_seen",">","2017-10-23 11:31:45 +00:00"], "and", [["anchor","like","%seo%"],"or",["text_pre","like","%seo%"]]] The full list of possible filters is available here.
order_bystring[]任意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"]
offsetinteger任意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; Note: the maximum value is 20,000, use the search_after_token if you would like to offset more results
search_after_tokenstring任意token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request; by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task; search_after_token values are unique for each subsequent task ; Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request
limitinteger任意the maximum number of returned backlinks optional field default value: 100 maximum value: 1000
backlinks_status_typestring任意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 target; 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
include_subdomainsboolean任意indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true
exclude_internal_backlinksboolean任意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 results default value: true
rank_scalestring任意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
tagstring任意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
リクエスト例
curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/backlinks/backlinks/live" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"target": "<string>",
"mode": "<string>",
"custom_mode": {},
"filters": "<string>",
"order_by": [
"<string>"
],
"offset": 0,
"search_after_token": "<string>",
"limit": 0
}'レスポンス
レスポンスのフィールド
versionstring任意the current version of the API
status_codeinteger任意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_messagestring任意general informational message you can find the full list of general informational messages here
timestring任意execution time, seconds
costnumber任意total tasks cost, USD
tasks_countinteger任意the number of tasks in the tasks array
tasks_errorinteger任意the number of tasks in the tasks array returned with an error
tasksstring[]任意array of tasks
idstring任意task identifier unique task identifier in our system in the UUID format
status_codeinteger任意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_messagestring任意informational message of the task you can find the full list of general informational messages here
timestring任意execution time, seconds
costnumber任意cost of the task, USD
result_countinteger任意number of elements in the result array
pathstring[]任意URL path
dataobject任意contains the same parameters that you specified in the POST request
resultstring[]任意array of results
targetstring任意target domain in a POST array
modestring任意mode specified in a POST array
custom_modeobject任意custom mode specified in a POST array
total_countinteger任意total amount of results relevant the request
items_countinteger任意the number of results returned in the items array
itemsstring[]任意contains relevant backlinks and referring domains data
typestring任意type of element = ‘backlink’
domain_fromstring任意domain referring to the target domain or webpage
url_fromstring任意URL of the page where the backlink is found
url_from_httpsboolean任意indicates whether the referring URL is secured with HTTPS if true, the referring URL is secured with HTTPS
domain_tostring任意domain the backlink is pointing to
url_tostring任意URL the backlink is pointing to
url_to_httpsboolean任意indicates if the URL the backlink is pointing to is secured with HTTPS if true, the URL is secured with HTTPS
tld_fromstring任意top-level domain of the referring URL
is_newboolean任意indicates whether the backlink is new if true, the backlink was found on the page last time our crawler visited it
is_lostboolean任意indicates whether the backlink was removed if true, the backlink or the entire page was removed
backlink_spam_scoreinteger任意spam score of the backlink learn more about how the metric is calculated on this help center page
rankinteger任意backlink rank rank that the given backlink passes to the target 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_rankinteger任意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_rankinteger任意domain rank of the referring domain 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[]任意platform types of the referring domain possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization
domain_from_is_ipboolean任意indicates if the domain is IP if true, the domain functions as an IP address and does not have a domain name
domain_from_ipstring任意IP address of the referring domain
domain_from_countrystring任意ISO country code of the referring domain
page_from_external_linksinteger任意number of external links found on the referring page
page_from_internal_linksinteger任意number of internal links found on the referring page
page_from_sizeinteger任意size of the referring page, in bytes example: 63357
page_from_encodingstring任意character encoding of the referring page example: utf-8
page_from_languagestring任意language of the referring page in ISO 639-1 format example: en
page_from_titlestring任意title of the referring page
page_from_status_codeinteger任意HTTP status code returned by the referring page example: 200
first_seenstring任意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_seenstring任意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_seenstring任意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_typestring任意link type possible values: anchor, image, meta, canonical, alternate, redirect
attributesstring[]任意link attributes of the referring links example: nofollow
dofollowboolean任意indicates whether the backlink is dofollow if false, the backlink is nofollow
originalboolean任意indicates whether the backlink was present on the referring page when our crawler first visited it
altstring任意alternative text of the image this field will be null if backlink type is not image
image_urlstring任意URL of the image the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
anchorstring任意anchor text of the backlink
text_prestring任意snippet before the anchor text
text_poststring任意snippet after the anchor text
semantic_locationstring任意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_countinteger任意number of identical backlinks found on the referring page
group_countinteger任意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_brokenboolean任意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_codeinteger任意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_scoreinteger任意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_targetstring任意target url of the redirect target page the redirect is pointing to
is_indirect_linkboolean任意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[]任意indirect link path indicates a URL or a sequence of URLs that lead to url_to
typestring任意indirect link type possible values: redirect, canonical
status_codeinteger任意HTTP status code of the URL
urlstring任意indirect link URL
search_after_tokenstring任意token for subsequent requests by specifying the unique search_after_token when setting a new task, you will get the subsequent results of the initial task; search_after_token values are unique for each subsequent task