NAVNavbar
Logo
cURL php NodeJS Python cSharp

Backlinks Timeseries Summary


This endpoint will provide you with an overview of backlink data for the target domain available during a period between the two indicated dates. Backlink metrics will be grouped by the time range that you define: day, week, month, or year.

Data from this endpoint will be especially helpful for building time-series graphs of daily, weekly, monthly, and yearly link-building progress.

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" => "dataforseo.com",
	"date_from" => "2021-12-01",
	"date_to" => "2022-02-01",
	"group_range" => "month"
);
try {
	// POST /v3/backlinks/timeseries_summary/live
	$result = $client->post('/v3/backlinks/timeseries_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.20220720",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.6546 sec.",
    "cost": 0.02009,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "07201648-1535-0459-0000-b6d7467aadd5",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0.0143 sec.",
            "cost": 0.02009,
            "result_count": 1,
            "path": [
                "v3",
                "backlinks",
                "timeseries_summary",
                "live"
            ],
            "data": {
                "api": "backlinks",
                "function": "timeseries_summary",
                "target": "dataforseo.com",
                "date_from": "2021-12-01",
                "date_to": "2022-02-01",
                "group_range": "month"
            },
            "result": [
                {
                    "target": "dataforseo.com",
                    "date_from": "2021-12-01",
                    "date_to": "2022-02-01",
                    "group_range": "month",
                    "items_count": 3,
                    "items": [
                        {
                            "type": "backlinks_timeseries_summary",
                            "date": "2021-12-31 00:00:00 +00:00",
                            "rank": 469,
                            "backlinks": 17265,
                            "backlinks_nofollow": 1017,
                            "referring_pages": 16551,
                            "referring_domains": 5269,
                            "referring_main_domains": 5228,
                            "referring_ips": 4618,
                            "referring_subnets": 3915
                        },
                        {
                            "type": "backlinks_timeseries_summary",
                            "date": "2022-01-31 00:00:00 +00:00",
                            "rank": 470,
                            "backlinks": 56628,
                            "backlinks_nofollow": 1343,
                            "referring_pages": 55791,
                            "referring_domains": 5600,
                            "referring_main_domains": 5555,
                            "referring_ips": 4969,
                            "referring_subnets": 4190
                        },
                        {
                            "type": "backlinks_timeseries_summary",
                            "date": "2022-02-28 00:00:00 +00:00",
                            "rank": 470,
                            "backlinks": 60364,
                            "backlinks_nofollow": 1817,
                            "referring_pages": 59379,
                            "referring_domains": 5821,
                            "referring_main_domains": 5773,
                            "referring_ips": 5206,
                            "referring_subnets": 4390
                        }
                    ]
                }
            ]
        }
    ]
}

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
target string domain to get data for
required field
a domain should be specified without https:// and www.
example:
"forbes.com"
date_from string starting date of the time range
optional field
this field indicates the date which will be used as a threshold for summary data;

minimum value: 2019-01-30
maximum value shouldn’t exceed the date specified in the date_to
date format: "yyyy-mm-dd"
example:
"2021-01-01"

date_to string ending date of the time range
optional field
if you don’t specify this field, the today’s date will be used by default
minimum value shouldn’t preceed the date specified in the date_from
maximum value: today’s date
date format: "yyyy-mm-dd"
example:
"2021-01-15"
group_range string time range which will be used to group the results
optional field
default value: month
possible values: day, week, month, year

note: for day, we will return items corresponding to all dates between and including date_from and date_to;
for week/month/year, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/year

for example, if you specify:
"group_range": "month",
"date_from": "2022-03-23",
"date_to": "2022-05-13"

we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31

if there is no data for a certain day/week/month/year, we will return 0

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 from a POST array
            date_from string starting date of the time range
in the UTC format: “yyyy-mm-dd”
example:
2019-01-01
            date_to string ending date of the time range
in the UTC format: "yyyy-mm-dd"
example:
"2019-01-15"
            group_range object group_range from a POST array
            total_count integer total amount of results relevant the request
            items_count integer the number of results returned in the items array
            items array contains relevant summary data
                    type string type of element = ‘backlinks_timeseries_summary’
                    date string date and time when the data for the target was stored
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 for the given date
learn more about the metric and how it is calculated in this help center article
                    backlinks integer number of backlinks for the given date
                    backlinks_nofollow integer number of nofollow backlinks for the given date
                    referring_pages integer number of pages pointing to target for the given date
                    referring_domains integer number of referring domains for the given date
referring domains include subdomains that are counted as separate domains for this metric
                    referring_main_domains integer number of referring main domains for the given date
                    referring_ips integer number of referring IP addresses for the given date
number of IP addresses pointing to this page
                    referring_subnets integer number of referring subnetworks for the given date

‌‌