dataforseo_labs/historical_rank_overview/live

Historical Rank Overview (Legacy)

‌‌‌

Note that the structure of DataForSEO Labs API requests and responses was updated on 2022-03-19. However, we will continue supporting the legacy version documented here. You can review the documentation of the new version by this link.

This endpoint will provide you with historical data on rankings and traffic of the specified domain, such as domain ranking distribution in SERPs and estimated monthly traffic volume for both organic and paid results.
Note that historical data is available starting from 2020-10-01.

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. 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 required field the domain name of the target website the domain should be specified without `https://` and `www.`
`location_name`	string	full name of the location required field if you don’t specify `location_code` Note: it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `United Kingdom`
`location_code`	integer	location code required field if you don’t specify `location_name` Note: it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `2840`
`language_name`	string	full name of the language required field if you don’t specify `language_code` Note: it is required to specify either `language_name` or `language_code` you can receive the list of available locations with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English`
`language_code`	string	language code required field if you don’t specify `language_name` Note: it is required to specify either `language_name` or `language_code` you can receive the list of available locations with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en`
`date_from`	string	starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 6 months minimal possible value: `2020-10-01` date format: `"yyyy-mm-dd"`
`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 date format: `"yyyy-mm-dd"` example: `"2021-04-01"`
`correlate`	boolean	correlate data with previously obtained datasets optional field default value: `true` if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended to mitigate any inconsistencies that may result from changes to our database we recommend always setting `correlate` to `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 domain in a POST array
`location_code`	integer	location code in a POST array
`language_code`	string	language code in a POST array
`total_count`	integer	total amount of results in our database relevant to your request
`items_count`	integer	the number of results returned in the `items` array
`items`	array	contains historical ranking and traffic data
`year`	integer	year for which the data is provided
`month`	integer	month for which the data is provided
`metrics`	object	ranking data relevant to the specified domain
`organic`	object	ranking and traffic data from organic search
`pos_1`	integer	number of organic SERPs where the domain ranks #1
`pos_2_3`	integer	number of organic SERPs where the domain ranks #2-3
`pos_4_10`	integer	number of organic SERPs where the domain ranks #4-10
`pos_11_20`	integer	number of organic SERPs where the domain ranks #11-20
`pos_21_30`	integer	number of organic SERPs where the domain ranks #21-30
`pos_31_40`	integer	number of organic SERPs where the domain ranks #31-40
`pos_41_50`	integer	number of organic SERPs where the domain ranks #41-50
`pos_51_60`	integer	number of organic SERPs where the domain ranks #51-60
`pos_61_70`	integer	number of organic SERPs where the domain ranks #61-70
`pos_71_80`	integer	number of organic SERPs where the domain ranks #71-80
`pos_81_90`	integer	number of organic SERPs where the domain ranks #81-90
`pos_91_100`	integer	number of organic SERPs where the domain ranks #91-100
`etv`	float	estimated traffic volume estimated organic monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article
`impressions_etv`	float	estimated traffic volume based on impressions estimated organic monthly traffic to the domain calculated as the product of CTR (click-through-rate) and impressions values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article
`count`	integer	total count of organic SERPs that contain the domain
`estimated_paid_traffic_cost`	float	estimated cost of converting organic search traffic into paid represents the estimated monthly cost of running ads (USD) for all keywords that a domain ranks for the metric is calculated as the product of organic `etv` and paid `cpc` values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search learn more about how the metric is calculated in this help center article
`is_new`	integer	number of new ranked elements indicates how many new ranked elements were found for the indicated target
`is_up`	integer	rank went up indicates how many ranked elements of the indicated target went up
`is_down`	integer	rank went down indicates how many ranked elements of the indicated target went down
`is_lost`	integer	lost ranked elements indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check
`paid`	object	ranking and traffic data from paid search
`pos_1`	integer	number of paid SERPs where the domain ranks #1
`pos_2_3`	integer	number of paid SERPs where the domain ranks #2-3
`pos_4_10`	integer	number of paid SERPs where the domain ranks #4-10
`pos_11_20`	integer	number of paid SERPs where the domain ranks #11-20
`pos_21_30`	integer	number of paid SERPs where the domain ranks #21-30
`pos_31_40`	integer	number of paid SERPs where the domain ranks #31-40
`pos_41_50`	integer	number of paid SERPs where the domain ranks #41-50
`pos_51_60`	integer	number of paid SERPs where the domain ranks #51-60
`pos_61_70`	integer	number of paid SERPs where the domain ranks #61-70
`pos_71_80`	integer	number of paid SERPs where the domain ranks #71-80
`pos_81_90`	integer	number of paid SERPs where the domain ranks #81-90
`pos_91_100`	integer	number of paid SERPs where the domain ranks #91-100
`etv`	float	estimated traffic volume estimated paid monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article
`impressions_etv`	float	estimated traffic volume based on impressions estimated paid monthly traffic to the domain calculated as the product of CTR (click-through-rate) and impressions values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article
`count`	integer	total count of paid SERPs that contain the domain
`estimated_paid_traffic_cost`	float	estimated cost of monthly search traffic represents the estimated cost of paid monthly traffic (USD) based on `etv` and `cpc` values learn more about how the metric is calculated in this help center article
`is_new`	integer	number of new ranked elements indicates how many new ranked elements were found for the indicated target
`is_up`	integer	rank went up indicates how many ranked elements of the indicated target went up
`is_down`	integer	rank went down indicates how many ranked elements of the indicated target went down
`is_lost`	integer	lost ranked elements indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check

‌‌

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/dataforseo_labs/historical_rank_overview/live" 
--header "Authorization: Basic ${cred}"  
--header "Content-Type: application/json" 
--data-raw "[
    {
        "target": "dataforseo.com",
        "location_code": 2840,
        "language_code": "en",
        "date_from": "2021-01-01",
        "date_to": "2021-03-29"
    }
]"

<?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 set a task
$post_array[] = array(
   "target" => "dataforseo.com",
   "language_name" => "English",
   "location_code" => 2840,
   "date_from" => "2021-01-01",
    "date_to" => "2021-03-29"
);
try {
   // POST /v3/dataforseo_labs/historical_rank_overview/live
   $result = $client->post('/v3/dataforseo_labs/historical_rank_overview/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": "dataforseo.com",
  "language_name": "English",
  "location_code": 2840,
  "date_from": "2021-01-01",
  "date_to": "2021-03-29"
});
const axios = require('axios');
axios({
  method: 'post',
  url: 'https://api.dataforseo.com/v3/dataforseo_labs/historical_rank_overview/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://cdn.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="dataforseo.com",
    location_name="United States",
    language_name="English",
    date_from="2021-01-01",
  	date_to="2021-03-29"    
)
# POST /v3/dataforseo_labs/historical_rank_overview/live
response = client.post("/v3/dataforseo_labs/historical_rank_overview/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 dataforseo_labs_historical_rank_overview_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>();
            postData.Add(new
            {
                target = "dataforseo.com",
                location_name = "United States",
                language_name = "English",
                date_from = "2021-01-01",
  		          date_to = "2021-03-29"   
            });
            // POST /v3/dataforseo_labs/historical_rank_overview/live
            // the full list of possible parameters is available in documentation
            var taskPostResponse = await httpClient.PostAsync("/v3/dataforseo_labs/historical_rank_overview/live", new StringContent(JsonConvert.SerializeObject(postData)));
            var result = JsonConvert.DeserializeObject(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.20210818",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "3.7830 sec.",
  "cost": 0.103,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "08261200-1535-0294-0000-ed145d1a2e70",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "3.7255 sec.",
      "cost": 0.103,
      "result_count": 1,
      "path": [
        "v3",
        "dataforseo_labs",
        "historical_rank_overview",
        "live"
      ],
      "data": {
        "api": "dataforseo_labs",
        "function": "historical_rank_overview",
        "target": "dataforseo.com",
        "location_code": 2840,
        "language_code": "en",
        "date_from": "2021-01-01",
        "date_to": "2021-03-29"
      },
      "result": [
        {
          "target": "dataforseo.com",
          "location_code": 2840,
          "language_code": "en",
          "total_count": 3,
          "items_count": 3,
          "items": [
            {
              "year": 2021,
              "month": 3,
              "metrics": {
                "organic": {
                  "pos_1": 9,
                  "pos_2_3": 19,
                  "pos_4_10": 80,
                  "pos_11_20": 110,
                  "pos_21_30": 153,
                  "pos_31_40": 184,
                  "pos_41_50": 176,
                  "pos_51_60": 173,
                  "pos_61_70": 164,
                  "pos_71_80": 176,
                  "pos_81_90": 138,
                  "pos_91_100": 117,
                  "etv": 1369.5610451982193,
                  "impressions_etv": 303.37293742540305,
                  "count": 1499,
                  "estimated_paid_traffic_cost": 8596.951706401509,
                  "is_new": 773,
                  "is_up": 0,
                  "is_down": 0,
                  "is_lost": 0
                },
                "paid": {
                  "pos_1": 7,
                  "pos_2_3": 5,
                  "pos_4_10": 0,
                  "pos_11_20": 0,
                  "pos_21_30": 0,
                  "pos_31_40": 0,
                  "pos_41_50": 0,
                  "pos_51_60": 0,
                  "pos_61_70": 0,
                  "pos_71_80": 0,
                  "pos_81_90": 0,
                  "pos_91_100": 0,
                  "etv": 11.335112532093206,
                  "impressions_etv": 0.6629726170007869,
                  "count": 12,
                  "estimated_paid_traffic_cost": 54.66883224599668,
                  "is_new": 10,
                  "is_up": 0,
                  "is_down": 0,
                  "is_lost": 0
                }
              }
            },
            {
              "year": 2021,
              "month": 2,
              "metrics": {
                "organic": {
                  "pos_1": 9,
                  "pos_2_3": 18,
                  "pos_4_10": 77,
                  "pos_11_20": 109,
                  "pos_21_30": 158,
                  "pos_31_40": 175,
                  "pos_41_50": 178,
                  "pos_51_60": 167,
                  "pos_61_70": 170,
                  "pos_71_80": 169,
                  "pos_81_90": 146,
                  "pos_91_100": 102,
                  "etv": 1303.1623692517926,
                  "impressions_etv": 237.4731694256393,
                  "count": 1478,
                  "estimated_paid_traffic_cost": 8113.11213429941,
                  "is_new": 762,
                  "is_up": 0,
                  "is_down": 0,
                  "is_lost": 0
                },
                "paid": {
                  "pos_1": 7,
                  "pos_2_3": 3,
                  "pos_4_10": 0,
                  "pos_11_20": 0,
                  "pos_21_30": 0,
                  "pos_31_40": 0,
                  "pos_41_50": 0,
                  "pos_51_60": 0,
                  "pos_61_70": 0,
                  "pos_71_80": 0,
                  "pos_81_90": 0,
                  "pos_91_100": 0,
                  "etv": 9.99005524824522,
                  "impressions_etv": 0.6736363357204526,
                  "count": 10,
                  "estimated_paid_traffic_cost": 57.2299567270445,
                  "is_new": 9,
                  "is_up": 0,
                  "is_down": 0,
                  "is_lost": 0
                }
              }
            },
            {
              "year": 2021,
              "month": 1,
              "metrics": {
                "organic": {
                  "pos_1": 8,
                  "pos_2_3": 18,
                  "pos_4_10": 35,
                  "pos_11_20": 64,
                  "pos_21_30": 128,
                  "pos_31_40": 148,
                  "pos_41_50": 170,
                  "pos_51_60": 135,
                  "pos_61_70": 142,
                  "pos_71_80": 135,
                  "pos_81_90": 119,
                  "pos_91_100": 80,
                  "etv": 1195.6438950218885,
                  "impressions_etv": 246.56584263386318,
                  "count": 1182,
                  "estimated_paid_traffic_cost": 6774.385158749256,
                  "is_new": 0,
                  "is_up": 0,
                  "is_down": 0,
                  "is_lost": 187
                },
                "paid": {
                  "pos_1": 7,
                  "pos_2_3": 7,
                  "pos_4_10": 2,
                  "pos_11_20": 0,
                  "pos_21_30": 0,
                  "pos_31_40": 0,
                  "pos_41_50": 0,
                  "pos_51_60": 0,
                  "pos_61_70": 0,
                  "pos_71_80": 0,
                  "pos_81_90": 0,
                  "pos_91_100": 0,
                  "etv": 12.439284899554357,
                  "impressions_etv": 2.47516056592828,
                  "count": 16,
                  "estimated_paid_traffic_cost": 97.89330946973304,
                  "is_new": 0,
                  "is_up": 0,
                  "is_down": 0,
                  "is_lost": 5
                }
              }
            }
          ]
        }
      ]
    }
  ]
}