NAVNavbar
Logo
cURL php NodeJS Python cSharp

Backlinks Summary


This endpoint will provide you with an overview of backlinks data available for a given domain, subdomain, or webpage.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// simple way to set a task
$post_array[] = array(
   "target" => "explodingtopics.com",
   "internal_list_limit" => 10,
   "include_subdomains" => true,
   "backlinks_filters" => ["dofollow", "=", true],
   "backlinks_status_type" => "all"
);
try {
   // POST /v3/backlinks/summary/live
   $result = $client->post('/v3/backlinks/summary/live', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "n";
   print "HTTP code: {$e->getHttpCode()}n";
   print "Error code: {$e->getCode()}n";
   print "Message: {$e->getMessage()}n";
   print  $e->getTraceAsString();
   echo "n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
  "version": "0.1.20210907",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.5133 sec.",
  "cost": 0.02003,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "09101544-1535-0265-0000-0672553a1263",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.4409 sec.",
      "cost": 0.02003,
      "result_count": 1,
      "path": [
        "v3",
        "backlinks",
        "summary",
        "live"
      ],
      "data": {
        "api": "backlinks",
        "function": "summary",
        "target": "explodingtopics.com",
        "internal_list_limit": 10,
        "include_subdomains": true,
        "backlinks_filters": [
          "dofollow",
          "=",
          true
        ],
        "backlinks_status_type": "all"
      },
      "result": [
        {
          "target": "explodingtopics.com",
          "first_seen": "2019-06-25 02:04:35 +00:00",
          "lost_date": null,
          "rank": 254,
          "backlinks": 2103,
          "crawled_pages": 16121,
          "info": {
            "server": "cloudflare",
            "cms": null,
            "platform_type": [
              "unknown"
            ],
            "ip_address": "172.67.211.235",
            "is_ip": false
          },
          "internal_links_count": 183764,
          "external_links_count": 43953,
          "broken_backlinks": 67,
          "broken_pages": 798,
          "referring_domains": 1013,
          "referring_main_domains": 973,
          "referring_ips": 932,
          "referring_subnets": 762,
          "referring_pages": 1940,
          "referring_links_tld": {
            "com": 1212,
            "co": 230,
            "net": 67,
            "it": 34,
            "co.uk": 34,
            "io": 25,
            "org": 22,
            "fr": 22,
            "ro": 18,
            "com.br": 17
          },
          "referring_links_types": {
            "anchor": 1741,
            "redirect": 196,
            "canonical": 3
          },
          "referring_links_attributes": {
            "noopener": 724,
            "noreferrer": 452,
            "external": 17,
            "ugc": 6
          },
          "referring_links_platform_types": {
            "unknown": 841,
            "cms": 788,
            "blogs": 771,
            "ecommerce": 83
          },
          "referring_links_semantic_locations": {
            "article": 776,
            "": 757,
            "section": 323,
            "main": 56,
            "figcaption": 13,
            "figure": 9,
            "header": 3,
            "aside": 2,
            "nav": 1
          }
        }
      ]
    }
  ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.

You can specify the number of results you want to retrieve, filter and sort them.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
target string domain, subdomain or webpage to get data 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://)
include_subdomains 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
internal_list_limit integer 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_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

backlinks_filters array 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]
tag 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

As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code 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 string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code 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
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            target string target in a POST array
            first_seen string date and time when our crawler found the backlink for the target 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 string date and time when the backlink was lost
indicates the date and time when our crawler visited the target and it responded with a 4xx or 5xx status code or when its last backlink was removed
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00
            rank integer target rank
            backlinks integer indicates the number of backlinks
            crawled_pages integer number of crawled pages for the target
            info object information about the target
                server string server
                cms string content management system
                platform_type array platform type
                ip_address string IP address of the target
                is_ip boolean indicates if the target is IP
if true, the domain, subdomain or webpage functions as an IP address and does not have a domain name
            internal_links_count integer number of internal links
calculated as the sum of internal links on the pages of the specified target
            external_links_count integer number of external links on the page
calculated as the sum of external links on the pages of the specified target
            broken_backlinks integer number of broken backlinks
number of broken backlinks pointing to the target
            broken_pages integer number of broken pages
number of pages on the target that respond with 4xx or 5xx status codes

note that the number of broken pages includes pages on the target discovered by following external links, but it may also include pages discovered by following the target’s sitemap

            referring_domains integer indicates the number of referring domains
referring domains include subdomains that are counted as separate domains for this metric
            referring_main_domains integer indicates the number of referring main domains
            referring_ips integer number of referring IP addresses
number of IP addresses pointing to this page
            referring_subnets integer number of referring subnetworks
            referring_pages integer indicates the number of pages pointing to the target
            referring_links_tld object top-level domains of the referring links
contains top level domains and referring link count per each
            referring_links_types object 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_attributes object link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute
example values:
nofollow, noopener, noreferrer, external, ugc, sponsored
            referring_links_platform_types object types of referring platforms
indicates referring platform types and and link count per each platform
example values:
cms, blogs, unknown, ecommerce, message-boards
            referring_links_semantic_locations object 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
example values:
article, section, summary, ""

‌‌