Felo API PlatformFelo API Platform

Data API / DataForSEO / Backlinks

Anchors

The anchor texts pointing at one target, one row per distinct anchor with anchor, rank, backlinks, first_seen, lost_date, backlinks_spam_score, broken_backlinks and broken_pages. Use it to see how the web describes a site - over-optimised anchors show up here. The link-level view is post_dataforseo_backlinks_backlinks_live; the domain-level one is post_dataforseo_backlinks_referring_domains_live.

Parameters

No path, query, or header parameters.

Request body

  • targetstringRequired

    domain, subdomain or webpage to get anchors 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://)

  • limitintegerOptional

    the maximum number of returned anchors optional field default value: 100 maximum value: 1000

  • offsetintegerOptional

    offset in the results array of returned anchors optional field default value: 0 if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors

  • 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: referring_links_tld referring_links_types referring_links_attributes referring_links_platform_types referring_links_semantic_locations default value: 10 maximum value: 1000

  • 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 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

  • 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: ["referring_links_types.anchors",">","1"] [["broken_pages",">","2"], "and", ["backlinks",">","10"]] [["first_seen",">","2017-10-23 11:31:45 +00:00"], "and", [["anchor","like","%seo%"],"or",["referring_domains",">","10"]]] 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: ["backlinks,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: ["backlinks,desc","rank,asc"]

  • backlinks_filtersarrayOptional

    filter the backlinks of your target optional field you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target you can filter the backlinks by all fields available in the response of this endpoint using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for example: "backlinks_filters": [["dofollow", "=", true]]

  • include_subdomainsbooleanOptional

    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

  • include_indirect_linksbooleanOptional

    indicates if indirect links to the target 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 the target, or points to a canonical page if set to false, indirect links will be ignored default value: true

  • exclude_internal_backlinksbooleanOptional

    indicates whether the backlinks from subdomains of the target are excluded optional field if set to false, the backlinks from subdomains of the target will be ommited and you won’t receive the same domain in the response; default value: true

  • 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/anchors/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "<string>",
  "limit": 0,
  "offset": 0,
  "internal_list_limit": 0,
  "backlinks_status_type": "<string>",
  "filters": "<string>",
  "order_by": [
    "<string>"
  ],
  "backlinks_filters": "<string>"
}'

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

  • targetstringOptional

    target in the post array

  • total_countintegerOptional

    total number of relevant items in the database

  • items_countintegerOptional

    number of items in the results array

  • itemsstring[]Optional

    items array

  • typestringOptional

    type of element = ‘backlinks_anchor’

  • anchorstringOptional

    anchor of the backlink

  • rankintegerOptional

    rank of the anchor links rank volume that referring websites pass to the target through links with a particular anchor 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

  • backlinksintegerOptional

    indicates the number of backlinks

  • first_seenstringOptional

    date and time when our crawler found the backlink with this anchor 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

  • lost_datestringOptional

    date and time when the last backlink with this anchor was lost indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2017-01-24 13:20:59 +00:00

  • backlinks_spam_scoreintegerOptional

    average spam score of all backlinks with this anchor learn more about how the metric is calculated on this help center page

  • broken_backlinksintegerOptional

    number of broken backlinks number of broken backlinks pointing to the target

  • broken_pagesintegerOptional

    number of broken pages number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to

  • referring_domainsintegerOptional

    indicates the number of referring domains

  • referring_domains_nofollowintegerOptional

    number of domains pointing at least one nofollow link to the target

  • referring_main_domainsintegerOptional

    indicates the number of referring main domains

  • referring_main_domains_nofollowintegerOptional

    number of main domains pointing at least one nofollow link to the target

  • referring_ipsintegerOptional

    number of referring IP addresses number of IP addresses pointing to this page

  • referring_subnetsintegerOptional

    number of referring subnetworks

  • referring_pagesintegerOptional

    indicates the number of pages pointing to target with this anchor

  • referring_links_tldobjectOptional

    top-level domains of the referring links contains top level domains and referring link count per each

  • referring_links_typesobjectOptional

    types of referring links indicates the types of the referring links and link count per each type possible values: anchor, image, link, meta, canonical, alternate, redirect

  • referring_links_attributesobjectOptional

    link attributes of the referring links indicates link attributes of the referring links and link count per each attribute

  • referring_links_platform_typesobjectOptional

    types of referring platforms indicates referring platform types and and link count per each platform possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization

  • referring_links_semantic_locationsobjectOptional

    semantic locations of the referring links indicates semantic elements in HTML where the referring links are located and link count per each semantic location you can get the full list of semantic elements here examples: article, section, summary

  • referring_links_countriesobjectOptional

    ISO country codes of the referring links indicates ISO country codes of the domains where the referring links are located and the link count per each country

  • referring_pages_nofollowintegerOptional

    number of referring pages pointing at least one nofollow link to the target with this anchor