Felo API PlatformFelo API Platform
All DataForSEO endpoints
v0.2.0-beta
OpenAPI 3.1.0

Referring Domains

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

Referring Domains

​

The domains linking to one target, one row per domain with domain, rank, backlinks, first_seen, lost_date, backlinks_spam_score, broken_backlinks and broken_pages. Referring domains matter more than raw backlink count, since a thousand links from one domain is one relationship. For the individual links use post_dataforseo_backlinks_backlinks_live; to collapse further, to network operators, use post_dataforseo_backlinks_referring_networks_live.

Pricing reference

  • Metering: Reported response cost.
  • Reference request estimate: USD 0.0276.
  • Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

Body
application/json
  • Type: array (object | null)[]
    • backlinks_filters
      Type: array (object | null)[] | null

      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]

      Empty object
    • backlinks_status_type
      Type: string | null

      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

    • exclude_internal_backlinks
      Type: boolean | null

      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

    • filters
      Type: array (object | null)[] | null

      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, match, not_match
      you can use the % operator with like and not_like to match any string of zero or more characters
      example:
      ["referring_pages",">","1"]

      [["referring_pages",">","2"],
      "and",
      ["backlinks",">","10"]]

      [["first_seen",">","2017-10-23 11:31:45 +00:00"],
      "and",
      [["domain","like","%dataforseo.com%"],"or",["referring_domains",">","10"]]]

      The full list of possible filters is available here.

      Empty object
    • include_indirect_links
      Type: boolean | null

      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

    • include_subdomains
      Type: boolean | null

      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

    • internal_list_limit
      Type: integer | null

      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

    • limit
      Type: integer | null

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

    • offset
      Type: integer | null

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

    • order_by
      Type: array string[] | null

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

    • rank_scale
      Type: string | null

      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

    • tag
      Type: string | null

      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

    • target
      Type: string

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

Responses
  • 200
    Type: object | null · Response36Afe1097B20_BacklinksReferringDomainsLiveResponseInfo
    • cost
      Type: number | null Format: double

      total tasks cost, USD

    • status_code
      Type: integer | null

      general status code you can find the full list of the response codes here

    • status_message
      Type: string | null

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

    • tasks
      Type: array (object | null)[] | null

      array of tasks

      • Type: object | null · Response36Afe1097B20_BacklinksReferringDomainsLiveTaskInfo
        • cost
          Type: number | null Format: double

          total tasks cost, USD

        • data
          Type: object | null

          contains the same parameters that you specified in the POST request

          • propertyName
            Type: object | null
        • id
          Type: string | null

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

        • path
          Type: array (string | null)[] | null

          URL path

        • result
          Type: array (object | null)[] | null

          array of results

          • items
            Type: array (object | null)[] | null

            items array

            • backlinks
              Type: integer | null Format: int64

              indicates the number of backlinks pointing to the target

            • backlinks_spam_score
              Type: integer | null Format: int64

              average spam score of all backlinks pointing to the domain
              learn more about how the metric is calculated on this help center page

            • broken_backlinks
              Type: integer | null Format: int64

              number of broken backlinks
              number of broken backlinks pointing to the domain

            • broken_pages
              Type: integer | null

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

            • domain
              Type: string | null

              referring domain

            • first_seen
              Type: string | null

              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

            • lost_date
              Type: string | null

              date and time when the last backlink from this domain 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

            • rank
              Type: integer | null

              domain rank
              rank volume that a referring website 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

            • referring_domains
              Type: integer | null Format: int64

              indicates the number of referring domains
              note that we calculate main domains (root domains, like example.com) and their subdomains (e.g. blog.example.com) separately for this metric

            • referring_domains_nofollow
              Type: integer | null Format: int64

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

            • referring_ips
              Type: integer | null Format: int64

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

            • referring_links_attributes
              Type: object | null

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

              • propertyName
                Type: integer | null Format: int64

                Signed 64-bit integers (long type).

            • referring_links_countries
              Type: object | null

              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

              • propertyName
                Type: integer | null Format: int64

                Signed 64-bit integers (long type).

            • referring_links_platform_types
              Type: object | null

              types of referring platforms
              indicates referring platform types and link count per each platform

              possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization

              • propertyName
                Type: integer | null Format: int64

                Signed 64-bit integers (long type).

            • referring_links_semantic_locations
              Type: object | null

              semantic locations of the referring links
              indicates semantic elements in HTML where the referring links are located and the link count per each semantic location

              you can get the full list of semantic elements here
              examples:
              article, section, summary

              • propertyName
                Type: integer | null Format: int64

                Signed 64-bit integers (long type).

            • referring_links_tld
              Type: object | null

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

              • propertyName
                Type: integer | null Format: int64

                Signed 64-bit integers (long type).

            • referring_links_types
              Type: object | null

              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

              • propertyName
                Type: integer | null Format: int64

                Signed 64-bit integers (long type).

            • referring_main_domains
              Type: integer | null Format: int64

              indicates the number of referring main domains
              the number of primary (root) domains referring to your target

            • referring_main_domains_nofollow
              Type: integer | null Format: int64

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

            • referring_pages
              Type: integer | null Format: int64

              indicates the number of pages pointing to the target specified

            • referring_pages_nofollow
              Type: integer | null Format: int64

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

            • referring_subnets
              Type: integer | null Format: int64

              number of referring subnetworks

            • type
              Type: string | null

              type of element

          • items_count
            Type: integer | null Format: int64

            number of items in the items array

          • target
            Type: string | null

            target in a POST array

          • total_count
            Type: integer | null Format: int64

            total number of relevant items in the database
            total number of main domains referring to your target;
            example.com and blog.example.com are counted as one referring domain

        • result_count
          Type: integer | null Format: int64

          number of elements in the result array

        • status_code
          Type: integer | null

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

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

        • time
          Type: string | null

          execution time, seconds

    • tasks_count
      Type: integer | null Format: int64

      the number of tasks in the tasks array

    • tasks_error
      Type: integer | null Format: int64

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

    • time
      Type: string | null

      total execution time, seconds

    • version
      Type: string | null

      the current version of the API

    application/json
  • 400

    The request could not be processed. Check the request parameters.

  • 401

    A valid Felo API key is required.

  • 402

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

  • 403

    The account is not permitted to perform this operation.

  • 429

    A request or spending limit has been reached.

  • 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

    Error response; upstream passthrough responses may use provider formats

    application/json
Request Example for post/v1/beta/dataforseo/backlinks/referring_domains/live
curl https://openapi.felo.ai/v1/beta/dataforseo/backlinks/referring_domains/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "backlinko.com",
    "limit": 5,
    "order_by": [
      "rank,desc"
    ],
    "exclude_internal_backlinks": true,
    "backlinks_filters": [
      "dofollow",
      "=",
      true
    ],
    "filters": [
      "backlinks",
      ">",
      100
    ]
  }
]'

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "target": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "type": null,
              "domain": null,
              "rank": null,
              "backlinks": null,
              "first_seen": null,
              "lost_date": null,
              "backlinks_spam_score": null,
              "broken_backlinks": null,
              "broken_pages": null,
              "referring_domains": null,
              "referring_domains_nofollow": null,
              "referring_main_domains": null,
              "referring_main_domains_nofollow": null,
              "referring_ips": null,
              "referring_subnets": null,
              "referring_pages": null,
              "referring_pages_nofollow": null,
              "referring_links_tld": null,
              "referring_links_types": null,
              "referring_links_attributes": null,
              "referring_links_platform_types": null,
              "referring_links_semantic_locations": null,
              "referring_links_countries": null
            }
          ]
        }
      ]
    }
  ]
}

Successful operation

Referring Domains

Need help?