This endpoint will provide you with the number of referring domains pointing to the domains, subdomains and pages specified in the targets array.
Note that if you indicate a domain as a target, you will get result for the root domain (domain with all of its subdomains), e.g. dataforseo.com and app.dataforseo.com
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(
"targets" => [
"forbes.com",
"cnn.com",
"bbc.com",
"yelp.com",
"https://www.apple.com/iphone/",
"https://ahrefs.com/blog/",
"ibm.com",
"https://variety.com/",
"https://stackoverflow.com/",
"www.trustpilot.com"
],
"date_from" => "2023-09-01"
);
try {
// POST /v3/backlinks/bulk_new_lost_referring_domains/live
$result = $client->post('/v3/backlinks/bulk_new_lost_referring_domains/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.20230825",
"status_code": 20000,
"status_message": "Ok.",
"time": "10.7157 sec.",
"cost": 0.0203,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"id": "09291618-1535-0350-0000-ceb4be23b495",
"status_code": 20000,
"status_message": "Ok.",
"time": "10.6593 sec.",
"cost": 0.0203,
"result_count": 1,
"path": [
"v3",
"backlinks",
"bulk_new_lost_referring_domains",
"live"
],
"data": {
"api": "backlinks",
"function": "bulk_new_lost_referring_domains",
"targets": [
"forbes.com",
"cnn.com",
"bbc.com",
"yelp.com",
"https://www.apple.com/iphone/",
"https://ahrefs.com/blog/",
"ibm.com",
"https://variety.com/",
"https://stackoverflow.com/",
"www.trustpilot.com"
],
"date_from": "2023-09-01"
},
"result": [
{
"items_count": 10,
"items": [
{
"target": "forbes.com",
"new_referring_domains": 37664,
"lost_referring_domains": 3692,
"new_referring_main_domains": 14825,
"lost_referring_main_domains": 1339
},
{
"target": "cnn.com",
"new_referring_domains": 28930,
"lost_referring_domains": 2645,
"new_referring_main_domains": 10288,
"lost_referring_main_domains": 882
},
{
"target": "bbc.com",
"new_referring_domains": 24191,
"lost_referring_domains": 2407,
"new_referring_main_domains": 9550,
"lost_referring_main_domains": 900
},
{
"target": "yelp.com",
"new_referring_domains": 28897,
"lost_referring_domains": 3790,
"new_referring_main_domains": 11338,
"lost_referring_main_domains": 1304
},
{
"target": "https://www.apple.com/iphone/",
"new_referring_domains": 660,
"lost_referring_domains": 134,
"new_referring_main_domains": 301,
"lost_referring_main_domains": 63
},
{
"target": "https://ahrefs.com/blog/",
"new_referring_domains": 140,
"lost_referring_domains": 23,
"new_referring_main_domains": 67,
"lost_referring_main_domains": 10
},
{
"target": "ibm.com",
"new_referring_domains": 20785,
"lost_referring_domains": 1643,
"new_referring_main_domains": 6144,
"lost_referring_main_domains": 620
},
{
"target": "https://variety.com/",
"new_referring_domains": 430,
"lost_referring_domains": 71,
"new_referring_main_domains": 191,
"lost_referring_main_domains": 33
},
{
"target": "https://stackoverflow.com/",
"new_referring_domains": 1099,
"lost_referring_domains": 164,
"new_referring_main_domains": 484,
"lost_referring_main_domains": 68
},
{
"target": "www.trustpilot.com",
"new_referring_domains": 7767,
"lost_referring_domains": 1545,
"new_referring_main_domains": 2951,
"lost_referring_main_domains": 646
}
]
}
]
}
]
}
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. The maximum number of requests that can be sent simultaneously is limited to 30.
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 |
|---|---|---|
targets |
array | domains, subdomains or webpages to get new & lost referring domains for required field you can set up to 1000 domains, subdomains or webpages the domain or subdomain should be specified without https:// and www.the page should be specified with absolute URL (including http:// or https://)example: "targets": [ |
date_from |
string | starting date of the time range optional field this field indicates the date which will be used as a threshold for new and lost referring domains; the referring domains that appeared in our index after the specified date will be considered as new; the referring domains that weren’t found after the specified date, but were present before, will be considered as lost; default value: today’s date -(minus) one month; date format: |
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 |
items_count |
integer | the number of results returned in the items array |
items |
array | contains relevant backlinks and referring domains data |
target |
string | domain, subdomain or webpage from a POST array |
new_referring_domains |
integer | number of new referring domains number of new referring domains pointing to the target
|
lost_referring_domains |
integer | number of lost referring domains number of lost referring domains of the target
|
new_referring_main_domains |
integer | number of new referring main domains pointing to the target
|
lost_referring_main_domains |
integer | number of lost referring main domains pointing to the target
|