データ API / DataForSEO / On Page
Links
Every link found during a crawl, by id. Filter with page_from and page_to to get the links out of or into one page. Returns total_items_count, items_count, items, and a search_after_token for paging - use that rather than offset past the first pages. Reads a finished crawl, so it needs the id from post_dataforseo_on_page_submit and returns crawl_progress plus a crawl_status of max_crawl_pages, pages_in_queue and pages_crawled - check those before trusting a small result, because a crawl still running simply has less to report. 💰 Free upstream: querying a finished crawl costs nothing, only the crawl itself does.
パラメータ
パス・クエリ・ヘッダーのパラメータはありません。
リクエストボディ
idstring必須ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04”
page_fromstring任意relative page URL optional field if you use this field, the API response will contain only links from the specified page note that in this field you can specify relative URLs only
page_tostring任意relative page URL optional field if you use this field, the API response will contain only internal links pointing to the specified page note that in this field you can specify relative URLs only
limitinteger任意the maximum number of returned links optional field default value: 100 maximum value: 1000
offsetinteger任意offset in the results array of returned links optional field default value: 0 if you specify the 10 value, the first ten links in the results array will be omitted and the data will be provided for the successive links
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: regex, not_regex, =, , in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: ["direction","=","external"] [["domain_to","","example.com"], "and", ["link_from","not_like","%example.com/blog%"]] [["direction","=","external"], "and", [["link_from","like","%example.com/blog%"],"or",["link_from","like","%example.com/help%"]]] The full list of possible filters is available by this link.
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
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/on_page/links" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "<string>",
"page_from": "<string>",
"page_to": "<string>",
"limit": 0,
"offset": 0,
"filters": "<string>",
"search_after_token": "<string>",
"tag": "<string>"
}'レスポンス
レスポンスのフィールド
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
crawl_progressstring任意status of the crawling session possible values: in_progress, finished
crawl_statusobject任意details of the crawling session
max_crawl_pagesinteger任意maximum number of pages to crawl indicates the max_crawl_pages limit you specified when setting a task
pages_in_queueinteger任意number of pages that are currently in the crawling queue
pages_crawledinteger任意number of crawled pages
total_items_countinteger任意total number of relevant items in the database
items_countinteger任意number of items in the results array
itemsstring[]任意items array
typestring任意type of the link = ‘redirect’ HTTP redirect with 3xx status code
domain_fromstring任意referring domain the link was found on this domain
domain_tostring任意referenced domain the link is pointing to this domain
page_fromstring任意referring page relative URL of the page on which the link was found
page_tostring任意referenced page relative URL of the page to which the link is pointing
link_fromstring任意referring page absolute URL of the page on which the link was found
link_tostring任意referenced page absolute URL of the page to which the link is pointing
link_attributestring[]任意link attribute added to external link indicates link attributes added to the link_to on the page_from ["ugc","noopener"]
dofollowboolean任意indicates whether the link is dofollow if the value is true, the link doesn’t have a rel="nofollow" attribute
page_from_schemestring任意url scheme of the referring page
page_to_schemestring任意url scheme of the referenced page
directionstring任意direction of the link possible values: internal, external
is_brokenboolean任意link is broken indicates whether a link is directing to a broken page or resource
textstring任意image text
is_link_relation_conflictboolean任意indicates that the link may have a conflict with another link if true, at least one link pointing to link_to has a rel="nofollow" attribute and at least one is dofollow
page_to_status_codeinteger任意status code of the referenced page status code of the page to which the link is pointing
image_altstring任意alternative text for the image
image_srcstring任意url of the image
is_valid_hreflangboolean任意hreflang validity status indicates whether the hreflang attribute is correctly implemented
hreflangstring任意hreflang attribute value language and optional country code specified in the hreflang attribute example: "en-US", "fr"