backlinks/domain_pages_summary/live

Domain Pages Summary

This endpoint will provide you with detailed summary data on all backlinks and related metrics for each page of the target domain or subdomain you specify. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page.

POST

Your account will be charged for each request.
The cost can be calculated on the Pricing page.

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.

Description of the fields for setting a task:

Field name	Type	Description
`target`	string	domain, subdomain or webpage to get summary 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://`)
`limit`	integer	the maximum number of returned anchors optional field default value: `100` maximum value: `1000`
`offset`	integer	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_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`
`filters`	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: `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_by`	array	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_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]]`
`include_subdomains`	boolean	indicates if the subdomains of the `target` domain will be included in the search optional field if set to `false`, the subdomains will be ignored default value: `true`
`include_indirect_links`	boolean	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_backlinks`	boolean	indicates whether the backlinks from subdomains of the `target` are excluded optional field if set to `false`, backlinks from the subdomains of the `target` domain will be ommited and you won’t receive the same domain in the response; default value: `true`
`rank_scale`	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
`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 the post array
`total_count`	integer	total number of relevant items in the database
`items_count`	integer	number of items in the results array
`items`	array	items array
`type`	string	type of element = ‘backlinks_page_summary’
`url`	string	page URL
`rank`	integer	page rank rank of the `page` `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
`backlinks`	integer	number of backlinks
`first_seen`	string	date and time when our crawler found a backlink to this page 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 last backlink to this page 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_score`	integer	average spam score of the backlinks pointing to the page learn more about how the metric is calculated on this help center page
`broken_backlinks`	integer	number of broken backlinks number of broken backlinks pointing to the page
`broken_pages`	integer	number of broken pages number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to
`referring_domains`	integer	indicates the number domains referring to the page
`referring_domains_nofollow`	integer	number of domains pointing at least one nofollow link to the `page`
`referring_main_domains`	integer	indicates the number of referring main domains
`referring_main_domains_nofollow`	integer	number of main domains pointing at least one nofollow link to the `page`
`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 relevant `url`
`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
`referring_links_platform_types`	object	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_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 examples: `article`, `section`, `footer`
`referring_links_countries`	object	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_nofollow`	integer	number of referring pages pointing at least one nofollow link to the `page`

‌‌

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

# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access 
login="login" 
password="password" 
cred="$(printf ${login}:${password} | base64)" 
curl --location --request POST "https://api.dataforseo.com/v3/backlinks/domain_pages_summary/live" 
--header "Authorization: Basic ${cred}"  
--header "Content-Type: application/json" 
--data-raw "[
    {
        "target": "forbes.com",
        "limit": 4,
        "order_by": ["backlinks,desc"]
    }
]"

<?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-access
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// simple way to get a result
$post_array[] = array(
   "target" => "forbes.com",
   "limit" => 4,
   "order_by" => ["backlinks,desc"]
);
try {
   // POST /v3/backlinks/domain_pages_summary/live
   // the full list of possible parameters is available in documentation
   $result = $client->post('/v3/backlinks/domain_pages_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;
?>

const post_array = [];

post_array.push({
  "target": "forbes.com",
  "limit": 4,
  "order_by": ["backlinks,desc"]
});

const axios = require('axios');

axios({
  method: 'post',
  url: 'https://api.dataforseo.com/v3/backlinks/domain_pages_summary/live',
  auth: {
    username: 'login',
    password: 'password'
  },
  data: post_array,
  headers: {
    'content-type': 'application/json'
  }
}).then(function (response) {
  var result = response['data']['tasks'];
  // Result data
  console.log(result);
}).catch(function (error) {
  console.log(error);
});

from client import RestClient
# You can download this file from here https://api.dataforseo.com/v3/_examples/python/_python_Client.zip
client = RestClient("login", "password")
post_data = dict()
# simple way to set a task
post_data[len(post_data)] = dict(
    target="forbes.com",
    limit=4,
    order_by=["backlinks,desc"]
)
# POST /v3/backlinks/domain_pages_summary/live
# the full list of possible parameters is available in documentation
response = client.post("/v3/backlinks/domain_pages_summary/live", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
    print(response)
    # do something with result
else:
    print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
namespace DataForSeoDemos
{
    public static partial class Demos
    {
        public static async Task backlinks_domain_pages_summary_live()
        {
            var httpClient = new HttpClient
            {
                BaseAddress = new Uri("https://api.dataforseo.com/"),
                // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
                DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
            };
            var postData = new List<object>();
            // simple way to get a result
            postData.Add(new
            {
                target = "forbes.com",
                limit = 4
            });
            // POST /v3/backlinks/domain_pages_summary/live
            // the full list of possible parameters is available in documentation
            var taskPostResponse = await httpClient.PostAsync("/v3/backlinks/domain_pages_summary/live", new StringContent(JsonConvert.SerializeObject(postData)));
            var result = JsonConvert.DeserializeObject<dynamic>(await taskPostResponse.Content.ReadAsStringAsync());
            // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
            if (result.status_code == 20000)
            {
                // do something with result
                Console.WriteLine(result);
            }
            else
                Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
        }
    }
}

The above command returns JSON structured like this:

{
  "version": "0.1.20230825",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "1.8813 sec.",
  "cost": 0.02012,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "09291813-1535-0445-0000-209426c919d5",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "1.8456 sec.",
      "cost": 0.02012,
      "result_count": 1,
      "path": [
        "v3",
        "backlinks",
        "domain_pages_summary",
        "live"
      ],
      "data": {
        "api": "backlinks",
        "function": "domain_pages_summary",
        "target": "forbes.com",
        "limit": 4,
        "order_by": [
          "backlinks,desc"
        ]
      },
      "result": [
        {
          "target": "forbes.com",
          "total_count": 3813583,
          "items_count": 4,
          "items": [
            {
              "type": "backlinks_page_summary",
              "url": "http://www.forbes.com/",
              "rank": 452,
              "backlinks": 1259787,
              "first_seen": "2019-01-15 22:56:46 +00:00",
              "lost_date": null,
              "backlinks_spam_score": 31,
              "broken_backlinks": 0,
              "broken_pages": 0,
              "referring_domains": 20369,
              "referring_domains_nofollow": 2690,
              "referring_main_domains": 17112,
              "referring_main_domains_nofollow": 2332,
              "referring_ips": 15154,
              "referring_subnets": 9934,
              "referring_pages": 706965,
              "referring_links_tld": {
                "com": 560282,
                "org": 58362,
                "blogspot.com": 22648,
                "fr": 20648,
                "ac.uk": 8697,
                "al": 6108,
                "net": 4840,
                "de": 3460,
                "ru": 2005,
                "pt": 1457
              },
              "referring_links_types": {
                "anchor": 534171,
                "image": 172482,
                "redirect": 308,
                "canonical": 4
              },
              "referring_links_attributes": {
                "noopener": 28649,
                "nofollow": 20928,
                "noreferrer": 4994,
                "ugc": 683,
                "external": 634,
                "author": 114,
                "alternate": 10,
                "bookmark": 9,
                "self": 6,
                "sponsored": 3
              },
              "referring_links_platform_types": {
                "unknown": 465195,
                "news": 143529,
                "blogs": 91093,
                "cms": 66664,
                "organization": 35860,
                "message-boards": 588,
                "wikis": 259,
                "ecommerce": 80
              },
              "referring_links_semantic_locations": {
                "": 586043,
                "article": 63666,
                "aside": 29492,
                "section": 12800,
                "footer": 4970,
                "nav": 4141,
                "main": 3974,
                "figure": 1478,
                "header": 243,
                "figcaption": 114
              },
              "referring_links_countries": {
                "": 377224,
                "DE": 129952,
                "US": 115580,
                "FR": 20987,
                "PH": 10587,
                "GB": 9912,
                "AL": 6108,
                "CZ": 5123,
                "WW": 4658,
                "CA": 4511
              },
              "referring_pages_nofollow": 55860
            },
            {
              "type": "backlinks_page_summary",
              "url": "https://www.forbes.com/sites/robinandrews/2018/10/07/here-is-why-earthquake-magnitude-is-not-what-you-think-it-is/",
              "rank": 91,
              "backlinks": 921033,
              "first_seen": "2019-07-19 11:01:23 +00:00",
              "lost_date": null,
              "backlinks_spam_score": 64,
              "broken_backlinks": 0,
              "broken_pages": 0,
              "referring_domains": 12,
              "referring_domains_nofollow": 0,
              "referring_main_domains": 12,
              "referring_main_domains_nofollow": 0,
              "referring_ips": 13,
              "referring_subnets": 13,
              "referring_pages": 230286,
              "referring_links_tld": {
                "uk": 230246,
                "com": 29,
                "org": 8,
                "us": 2,
                "net": 1
              },
              "referring_links_types": {
                "anchor": 230285,
                "redirect": 1
              },
              "referring_links_attributes": {
                "noopener": 11,
                "noreferrer": 5
              },
              "referring_links_platform_types": {
                "unknown": 230255,
                "blogs": 27,
                "cms": 27,
                "news": 2,
                "organization": 2
              },
              "referring_links_semantic_locations": {
                "": 230250,
                "article": 28,
                "main": 4,
                "section": 4
              },
              "referring_links_countries": {
                "GB": 230246,
                "": 28,
                "US": 11,
                "PH": 1
              },
              "referring_pages_nofollow": 1
            },
            {
              "type": "backlinks_page_summary",
              "url": "http://www.forbes.com/sites/ryanmac/2015/10/14/buildzoom-raises-10-6-million-from-formation-8-y-combinator-to-focus-on-high-end-home-improvements/",
              "rank": 520,
              "backlinks": 917870,
              "first_seen": "2019-08-22 05:04:45 +00:00",
              "lost_date": null,
              "backlinks_spam_score": 0,
              "broken_backlinks": 0,
              "broken_pages": 0,
              "referring_domains": 5,
              "referring_domains_nofollow": 1,
              "referring_main_domains": 5,
              "referring_main_domains_nofollow": 1,
              "referring_ips": 6,
              "referring_subnets": 6,
              "referring_pages": 917869,
              "referring_links_tld": {
                "com": 917868,
                "eu": 1
              },
              "referring_links_types": {
                "anchor": 917869
              },
              "referring_links_attributes": {
                "nofollow": 1
              },
              "referring_links_platform_types": {
                "unknown": 525878,
                "organization": 364922,
                "message-boards": 27068,
                "news": 1
              },
              "referring_links_semantic_locations": {
                "": 917867,
                "section": 2
              },
              "referring_links_countries": {
                "US": 917784,
                "": 83,
                "NG": 1,
                "WW": 1
              },
              "referring_pages_nofollow": 41022
            },
            {
              "type": "backlinks_page_summary",
              "url": "https://www.forbes.com/",
              "rank": 627,
              "backlinks": 591741,
              "first_seen": "2019-01-15 23:17:44 +00:00",
              "lost_date": null,
              "backlinks_spam_score": 6,
              "broken_backlinks": 0,
              "broken_pages": 0,
              "referring_domains": 29376,
              "referring_domains_nofollow": 4173,
              "referring_main_domains": 21869,
              "referring_main_domains_nofollow": 3606,
              "referring_ips": 19741,
              "referring_subnets": 10999,
              "referring_pages": 563143,
              "referring_links_tld": {
                "com": 250451,
                "ir": 238172,
                "co": 11163,
                "ru": 8329,
                "org": 8229,
                "us": 3711,
                "net": 2686,
                "at": 2613,
                "edu.vn": 2352,
                "vn": 2038
              },
              "referring_links_types": {
                "anchor": 539615,
                "image": 13465,
                "canonical": 10006,
                "redirect": 57
              },
              "referring_links_attributes": {
                "noopener": 109173,
                "noreferrer": 78488,
                "nofollow": 75109,
                "external": 960,
                "ugc": 486,
                "author": 67,
                "sponsored": 35,
                "alternate": 8,
                "bookmark": 4,
                "help": 3
              },
              "referring_links_platform_types": {
                "news": 368924,
                "cms": 315647,
                "blogs": 312626,
                "organization": 206142,
                "unknown": 62020,
                "message-boards": 922,
                "wikis": 889,
                "ecommerce": 425
              },
              "referring_links_semantic_locations": {
                "footer": 194879,
                "": 178781,
                "article": 62248,
                "section": 59871,
                "aside": 55139,
                "main": 8153,
                "header": 2071,
                "nav": 948,
                "figure": 694,
                "figcaption": 268
              },
              "referring_links_countries": {
                "IR": 238212,
                "": 138801,
                "US": 72094,
                "WW": 57619,
                "CO": 11210,
                "RU": 8418,
                "VN": 5026,
                "AT": 2621,
                "FR": 2240,
                "SG": 2116
              },
              "referring_pages_nofollow": 0
            }
          ]
        }
      ]
    }
  ]
}