Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Backlinks

Felo API Support
MIT
Server:https://openapi.felo.ai
Client Libraries
Shell Curl

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operations

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.

Body
required
application/json
  • Type: array object[]
    • target
      Type: string
      required

      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://)

    • backlinks_status_type
      Type: string

      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

    • custom_mode
      Type: object

      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}

      • field
        Type: string
      • value
        Type: integer

        Integer numbers.

    • exclude_internal_backlinks
      Type: boolean

      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

    • filters
      Type: array

      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.

    • include_subdomains
      Type: boolean

      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

    • limit
      Type: integer

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

    • mode
      Type: string

      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

    • offset
      Type: integer

      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

    • order_by
      Type: array string[]

      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"]

    • rank_scale
      Type: string

      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

    • search_after_token
      Type: string

      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

    • tag
      Type: string

      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

Responses
  • 200
    Type: object

    Successful response

    • cost
      Type: number

      total tasks cost, USD

    • status_code
      Type: integer

      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_message
      Type: string

      general informational message you can find the full list of general informational messages here

    • tasks
      Type: array string[]

      array of tasks

    • tasks_count
      Type: integer

      the number of tasks in the tasks array

    • tasks_error
      Type: integer

      the number of tasks in the tasks array returned with an error

    • tasks.cost
      Type: number

      cost of the task, USD

    • tasks.data
      Type: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      Type: string

      task identifier unique task identifier in our system in the UUID format

    • tasks.path
      Type: array string[]

      URL path

    • tasks.result
      Type: array string[]

      array of results

    • tasks.result_count
      Type: integer

      number of elements in the result array

    • tasks.result.custom_mode
      Type: object

      custom mode specified in a POST array

    • tasks.result.items
      Type: array string[]

      contains relevant backlinks and referring domains data

    • tasks.result.items_count
      Type: integer

      the number of results returned in the items array

    • tasks.result.items.alt
      Type: string

      alternative text of the image this field will be null if backlink type is not image

    • tasks.result.items.anchor
      Type: string

      anchor text of the backlink

    • tasks.result.items.attributes
      Type: array string[]

      link attributes of the referring links example: nofollow

    • Type: integer

      spam score of the backlink learn more about how the metric is calculated on this help center page

    • tasks.result.items.dofollow
      Type: boolean

      indicates whether the backlink is dofollow if false, the backlink is nofollow

    • tasks.result.items.domain_from
      Type: string

      domain referring to the target domain or webpage

    • tasks.result.items.domain_from_country
      Type: string

      ISO country code of the referring domain

    • tasks.result.items.domain_from_ip
      Type: string

      IP address of the referring domain

    • tasks.result.items.domain_from_is_ip
      Type: boolean

      indicates if the domain is IP if true, the domain functions as an IP address and does not have a domain name

    • tasks.result.items.domain_from_platform_type
      Type: array string[]

      platform types of the referring domain possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization

    • tasks.result.items.domain_from_rank
      Type: integer

      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

    • tasks.result.items.domain_to
      Type: string

      domain the backlink is pointing to

    • tasks.result.items.first_seen
      Type: string

      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

    • tasks.result.items.group_count
      Type: integer

      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

    • tasks.result.items.image_url
      Type: string

      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)

    • Type: array string[]

      indirect link path indicates a URL or a sequence of URLs that lead to url_to

    • Type: integer

      HTTP status code of the URL

    • Type: string

      indirect link type possible values: redirect, canonical

    • Type: string

      indirect link URL

    • tasks.result.items.is_broken
      Type: boolean

      indicates whether the backlink is broken if true, the backlink is pointing to a page responding with a 4xx or 5xx status code

    • Type: boolean

      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

    • tasks.result.items.is_lost
      Type: boolean

      indicates whether the backlink was removed if true, the backlink or the entire page was removed

    • tasks.result.items.is_new
      Type: boolean

      indicates whether the backlink is new if true, the backlink was found on the page last time our crawler visited it

    • tasks.result.items.item_type
      Type: string

      link type possible values: anchor, image, meta, canonical, alternate, redirect

    • tasks.result.items.last_seen
      Type: string

      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

    • Type: integer

      number of identical backlinks found on the referring page

    • tasks.result.items.original
      Type: boolean

      indicates whether the backlink was present on the referring page when our crawler first visited it

    • tasks.result.items.page_from_encoding
      Type: string

      character encoding of the referring page example: utf-8

    • Type: integer

      number of external links found on the referring page

    • Type: integer

      number of internal links found on the referring page

    • tasks.result.items.page_from_language
      Type: string

      language of the referring page in ISO 639-1 format example: en

    • tasks.result.items.page_from_rank
      Type: integer

      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

    • tasks.result.items.page_from_size
      Type: integer

      size of the referring page, in bytes example: 63357

    • tasks.result.items.page_from_status_code
      Type: integer

      HTTP status code returned by the referring page example: 200

    • tasks.result.items.page_from_title
      Type: string

      title of the referring page

    • tasks.result.items.prev_seen
      Type: string

      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

    • tasks.result.items.rank
      Type: integer

      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

    • tasks.result.items.semantic_location
      Type: string

      indicates semantic element in HTML where the backlink is found you can get the full list of semantic elements here examples: article, section, summary

    • tasks.result.items.text_post
      Type: string

      snippet after the anchor text

    • tasks.result.items.text_pre
      Type: string

      snippet before the anchor text

    • tasks.result.items.tld_from
      Type: string

      top-level domain of the referring URL

    • tasks.result.items.type
      Type: string

      type of element = ‘backlink’

    • tasks.result.items.url_from
      Type: string

      URL of the page where the backlink is found

    • tasks.result.items.url_from_https
      Type: boolean

      indicates whether the referring URL is secured with HTTPS if true, the referring URL is secured with HTTPS

    • tasks.result.items.url_to
      Type: string

      URL the backlink is pointing to

    • tasks.result.items.url_to_https
      Type: boolean

      indicates if the URL the backlink is pointing to is secured with HTTPS if true, the URL is secured with HTTPS

    • tasks.result.items.url_to_redirect_target
      Type: string

      target url of the redirect target page the redirect is pointing to

    • tasks.result.items.url_to_spam_score
      Type: integer

      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

    • tasks.result.items.url_to_status_code
      Type: integer

      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

    • tasks.result.mode
      Type: string

      mode specified in a POST array

    • tasks.result.search_after_token
      Type: string

      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

    • tasks.result.target
      Type: string

      target domain in a POST array

    • tasks.result.total_count
      Type: integer

      total amount of results relevant the request

    • tasks.status_code
      Type: integer

      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

    • tasks.status_message
      Type: string

      informational message of the task you can find the full list of general informational messages here

    • tasks.time
      Type: string

      execution time, seconds

    • time
      Type: string

      execution time, seconds

    • version
      Type: string

      the current version of the API

    application/json
  • 400

    Bad request

  • 401

    Unauthorized

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    Rate limit exceeded

  • 500

    Internal server error

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/dataforseo/backlinks/backlinks/live
curl https://openapi.felo.ai/v1/beta/dataforseo/backlinks/backlinks/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "",
    "mode": "",
    "custom_mode": {
      "field": "",
      "value": 1
    },
    "filters": [],
    "order_by": [
      ""
    ],
    "offset": 1,
    "search_after_token": "",
    "limit": 1,
    "backlinks_status_type": "",
    "include_subdomains": true,
    "exclude_internal_backlinks": true,
    "rank_scale": "",
    "tag": ""
  }
]'

{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.target": "string",
  "tasks.result.mode": "string",
  "tasks.result.custom_mode": {},
  "tasks.result.total_count": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.type": "string",
  "tasks.result.items.domain_from": "string",
  "tasks.result.items.url_from": "string",
  "tasks.result.items.url_from_https": true,
  "tasks.result.items.domain_to": "string",
  "tasks.result.items.url_to": "string",
  "tasks.result.items.url_to_https": true,
  "tasks.result.items.tld_from": "string",
  "tasks.result.items.is_new": true,
  "tasks.result.items.is_lost": true,
  "tasks.result.items.backlink_spam_score": 1,
  "tasks.result.items.rank": 1,
  "tasks.result.items.page_from_rank": 1,
  "tasks.result.items.domain_from_rank": 1,
  "tasks.result.items.domain_from_platform_type": [
    "string"
  ],
  "tasks.result.items.domain_from_is_ip": true,
  "tasks.result.items.domain_from_ip": "string",
  "tasks.result.items.domain_from_country": "string",
  "tasks.result.items.page_from_external_links": 1,
  "tasks.result.items.page_from_internal_links": 1,
  "tasks.result.items.page_from_size": 1,
  "tasks.result.items.page_from_encoding": "string",
  "tasks.result.items.page_from_language": "string",
  "tasks.result.items.page_from_title": "string",
  "tasks.result.items.page_from_status_code": 1,
  "tasks.result.items.first_seen": "string",
  "tasks.result.items.prev_seen": "string",
  "tasks.result.items.last_seen": "string",
  "tasks.result.items.item_type": "string",
  "tasks.result.items.attributes": [
    "string"
  ],
  "tasks.result.items.dofollow": true,
  "tasks.result.items.original": true,
  "tasks.result.items.alt": "string",
  "tasks.result.items.image_url": "string",
  "tasks.result.items.anchor": "string",
  "tasks.result.items.text_pre": "string",
  "tasks.result.items.text_post": "string",
  "tasks.result.items.semantic_location": "string",
  "tasks.result.items.links_count": 1,
  "tasks.result.items.group_count": 1,
  "tasks.result.items.is_broken": true,
  "tasks.result.items.url_to_status_code": 1,
  "tasks.result.items.url_to_spam_score": 1,
  "tasks.result.items.url_to_redirect_target": "string",
  "tasks.result.items.is_indirect_link": true,
  "tasks.result.items.indirect_link_path": [
    "string"
  ],
  "tasks.result.items.indirect_link_path.type": "string",
  "tasks.result.items.indirect_link_path.status_code": 1,
  "tasks.result.items.indirect_link_path.url": "string",
  "tasks.result.search_after_token": "string"
}

Successful response

Backlinks