Skip to main content
POST
https://api.aisa.one/apis/v1
/
dataforseo
/
dataforseo_labs
/
google
/
historical_rank_overview
/
live
Historical Rank Overview
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_rank_overview/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": "<string>",
  "location_name": "<string>",
  "location_code": 123,
  "language_name": "<string>",
  "language_code": "<string>",
  "date_from": "<string>",
  "date_to": "<string>",
  "correlate": true,
  "ignore_synonyms": true,
  "include_clickstream_data": true,
  "tag": "<string>"
}
'
{
  "version": "<string>",
  "status_code": 123,
  "status_message": "<string>",
  "time": "<string>",
  "cost": 123,
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    "<string>"
  ],
  "tasks.id": "<string>",
  "tasks.status_code": 123,
  "tasks.status_message": "<string>",
  "tasks.time": "<string>",
  "tasks.cost": 123,
  "tasks.result_count": 123,
  "tasks.path": [
    "<string>"
  ],
  "tasks.data": {},
  "tasks.result": [
    "<string>"
  ],
  "tasks.result.se_type": "<string>",
  "tasks.result.target": "<string>",
  "tasks.result.location_code": 123,
  "tasks.result.language_code": "<string>",
  "tasks.result.total_count": 123,
  "tasks.result.items_count": 123,
  "tasks.result.items": [
    "<string>"
  ],
  "tasks.result.items.se_type": "<string>",
  "tasks.result.items.year": 123,
  "tasks.result.items.month": 123,
  "tasks.result.items.metrics": {},
  "tasks.result.items.metrics.organic": {},
  "tasks.result.items.metrics.organic.pos_1": 123,
  "tasks.result.items.metrics.organic.pos_2_3": 123,
  "tasks.result.items.metrics.organic.pos_4_10": 123,
  "tasks.result.items.metrics.organic.pos_11_20": 123,
  "tasks.result.items.metrics.organic.pos_21_30": 123,
  "tasks.result.items.metrics.organic.pos_31_40": 123,
  "tasks.result.items.metrics.organic.pos_41_50": 123,
  "tasks.result.items.metrics.organic.pos_51_60": 123,
  "tasks.result.items.metrics.organic.pos_61_70": 123,
  "tasks.result.items.metrics.organic.pos_71_80": 123,
  "tasks.result.items.metrics.organic.pos_81_90": 123,
  "tasks.result.items.metrics.organic.pos_91_100": 123,
  "tasks.result.items.metrics.organic.etv": 123,
  "tasks.result.items.metrics.organic.count": 123,
  "tasks.result.items.metrics.organic.estimated_paid_traffic_cost": 123,
  "tasks.result.items.metrics.organic.is_new": 123,
  "tasks.result.items.metrics.organic.is_up": 123,
  "tasks.result.items.metrics.organic.is_down": 123,
  "tasks.result.items.metrics.organic.is_lost": 123,
  "tasks.result.items.metrics.organic.clickstream_etv": 123,
  "tasks.result.items.metrics.organic.clickstream_gender_distribution": {},
  "tasks.result.items.metrics.organic.female": 123,
  "tasks.result.items.metrics.organic.male": 123,
  "tasks.result.items.metrics.organic.clickstream_age_distribution": {},
  "tasks.result.items.metrics.organic.18-24": 123,
  "tasks.result.items.metrics.organic.25-34": 123,
  "tasks.result.items.metrics.organic.35-44": 123,
  "tasks.result.items.metrics.organic.45-54": 123,
  "tasks.result.items.metrics.organic.55-64": 123,
  "tasks.result.items.metrics.paid": {},
  "tasks.result.items.metrics.paid.pos_1": 123,
  "tasks.result.items.metrics.paid.pos_2_3": 123,
  "tasks.result.items.metrics.paid.pos_4_10": 123,
  "tasks.result.items.metrics.paid.pos_11_20": 123,
  "tasks.result.items.metrics.paid.pos_21_30": 123,
  "tasks.result.items.metrics.paid.pos_31_40": 123,
  "tasks.result.items.metrics.paid.pos_41_50": 123,
  "tasks.result.items.metrics.paid.pos_51_60": 123,
  "tasks.result.items.metrics.paid.pos_61_70": 123,
  "tasks.result.items.metrics.paid.pos_71_80": 123,
  "tasks.result.items.metrics.paid.pos_81_90": 123,
  "tasks.result.items.metrics.paid.pos_91_100": 123,
  "tasks.result.items.metrics.paid.etv": 123,
  "tasks.result.items.metrics.paid.count": 123,
  "tasks.result.items.metrics.paid.estimated_paid_traffic_cost": 123,
  "tasks.result.items.metrics.paid.is_new": 123,
  "tasks.result.items.metrics.paid.is_up": 123,
  "tasks.result.items.metrics.paid.is_down": 123,
  "tasks.result.items.metrics.paid.is_lost": 123,
  "tasks.result.items.metrics.paid.clickstream_etv": 123,
  "tasks.result.items.metrics.paid.clickstream_gender_distribution": {},
  "tasks.result.items.metrics.paid.female": 123,
  "tasks.result.items.metrics.paid.male": 123,
  "tasks.result.items.metrics.paid.clickstream_age_distribution": {},
  "tasks.result.items.metrics.paid.18-24": 123,
  "tasks.result.items.metrics.paid.25-34": 123,
  "tasks.result.items.metrics.paid.35-44": 123,
  "tasks.result.items.metrics.paid.45-54": 123,
  "tasks.result.items.metrics.paid.55-64": 123
}

Documentation Index

Fetch the complete documentation index at: https://aisa.one/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
target
string
required

domain required field the domain name of the target website the domain should be specified without https:// and www.

​
location_name
string
required

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
required

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
required

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
required

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

​
ignore_synonyms
boolean

ignore highly similar keywords optional field if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; default value: false

​
include_clickstream_data
boolean

include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response; default value: false; Note: historical clickstream data is available from 2024/05 (May, 2024); with this parameter enabled, you will be charged double the price for the request; learn more about how clickstream-based 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

Response

Successful response

​
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
number

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
string[]

array of tasks

​
tasks.id
string

task identifier unique task identifier in our system in the UUID format

​
tasks.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

​
tasks.status_message
string

informational message of the task you can find the full list of general informational messages here

​
tasks.time
string

execution time, seconds

​
tasks.cost
number

cost of the task, USD

​
tasks.result_count
integer

number of elements in the result array

​
tasks.path
string[]

URL path

​
tasks.data
object

contains the same parameters that you specified in the POST request

​
tasks.result
string[]

array of results

​
tasks.result.se_type
string

search engine type

​
tasks.result.target
string

target domain in a POST array

​
tasks.result.location_code
integer

location code in a POST array

​
tasks.result.language_code
string

language code in a POST array

​
tasks.result.total_count
integer

total amount of results in our database relevant to your request

​
tasks.result.items_count
integer

the number of results returned in the items array

​
tasks.result.items
string[]

contains historical ranking and traffic data

​
tasks.result.items.se_type
string

search engine type

​
tasks.result.items.year
integer

year for which the data is provided

​
tasks.result.items.month
integer

month for which the data is provided

​
tasks.result.items.metrics
object

ranking data relevant to the specified domain

​
tasks.result.items.metrics.organic
object

ranking and traffic data from organic search

​
tasks.result.items.metrics.organic.pos_1
integer

number of organic SERPs where the domain ranks #1

​
tasks.result.items.metrics.organic.pos_2_3
integer

number of organic SERPs where the domain ranks #2-3

​
tasks.result.items.metrics.organic.pos_4_10
integer

number of organic SERPs where the domain ranks #4-10

​
tasks.result.items.metrics.organic.pos_11_20
integer

number of organic SERPs where the domain ranks #11-20

​
tasks.result.items.metrics.organic.pos_21_30
integer

number of organic SERPs where the domain ranks #21-30

​
tasks.result.items.metrics.organic.pos_31_40
integer

number of organic SERPs where the domain ranks #31-40

​
tasks.result.items.metrics.organic.pos_41_50
integer

number of organic SERPs where the domain ranks #41-50

​
tasks.result.items.metrics.organic.pos_51_60
integer

number of organic SERPs where the domain ranks #51-60

​
tasks.result.items.metrics.organic.pos_61_70
integer

number of organic SERPs where the domain ranks #61-70

​
tasks.result.items.metrics.organic.pos_71_80
integer

number of organic SERPs where the domain ranks #71-80

​
tasks.result.items.metrics.organic.pos_81_90
integer

number of organic SERPs where the domain ranks #81-90

​
tasks.result.items.metrics.organic.pos_91_100
integer

number of organic SERPs where the domain ranks #91-100

​
tasks.result.items.metrics.organic.etv
number

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

​
tasks.result.items.metrics.organic.count
integer

total count of organic SERPs that contain the domain

​
tasks.result.items.metrics.organic.estimated_paid_traffic_cost
number

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

​
tasks.result.items.metrics.organic.is_new
integer

number of new ranked elements indicates how many new ranked elements were found for the indicated target

​
tasks.result.items.metrics.organic.is_up
integer

rank went up indicates how many ranked elements of the indicated target went up

​
tasks.result.items.metrics.organic.is_down
integer

rank went down indicates how many ranked elements of the indicated target went down

​
tasks.result.items.metrics.organic.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

​
tasks.result.items.metrics.organic.clickstream_etv
integer

estimated traffic volume based on clickstream data calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

​
tasks.result.items.metrics.organic.clickstream_gender_distribution
object

distribution of estimated clickstream-based metrics by gender to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

​
tasks.result.items.metrics.organic.female
integer

number of female users in the relevant clickstream dataset

​
tasks.result.items.metrics.organic.male
integer

number of male users in the relevant clickstream dataset

​
tasks.result.items.metrics.organic.clickstream_age_distribution
object

distribution of clickstream-based metrics by age to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

​
tasks.result.items.metrics.organic.18-24
integer

number of users in the relevant clickstream dataset that fall within the 18-24 age range

​
tasks.result.items.metrics.organic.25-34
integer

number of users in the relevant clickstream dataset that fall within the 25-34 age range

​
tasks.result.items.metrics.organic.35-44
integer

number of users in the relevant clickstream dataset that fall within the 35-44 age range

​
tasks.result.items.metrics.organic.45-54
integer

number of users in the relevant clickstream dataset that fall within the 45-54 age range

​
tasks.result.items.metrics.organic.55-64
integer

number of users in the relevant clickstream dataset that fall within the 55-64 age range

​
tasks.result.items.metrics.paid
object

ranking and traffic data from paid search

​
tasks.result.items.metrics.paid.pos_1
integer

number of paid SERPs where the domain ranks #1

​
tasks.result.items.metrics.paid.pos_2_3
integer

number of paid SERPs where the domain ranks #2-3

​
tasks.result.items.metrics.paid.pos_4_10
integer

number of paid SERPs where the domain ranks #4-10

​
tasks.result.items.metrics.paid.pos_11_20
integer

number of paid SERPs where the domain ranks #11-20

​
tasks.result.items.metrics.paid.pos_21_30
integer

number of paid SERPs where the domain ranks #21-30

​
tasks.result.items.metrics.paid.pos_31_40
integer

number of paid SERPs where the domain ranks #31-40

​
tasks.result.items.metrics.paid.pos_41_50
integer

number of paid SERPs where the domain ranks #41-50

​
tasks.result.items.metrics.paid.pos_51_60
integer

number of paid SERPs where the domain ranks #51-60

​
tasks.result.items.metrics.paid.pos_61_70
integer

number of paid SERPs where the domain ranks #61-70

​
tasks.result.items.metrics.paid.pos_71_80
integer

number of paid SERPs where the domain ranks #71-80

​
tasks.result.items.metrics.paid.pos_81_90
integer

number of paid SERPs where the domain ranks #81-90

​
tasks.result.items.metrics.paid.pos_91_100
integer

number of paid SERPs where the domain ranks #91-100

​
tasks.result.items.metrics.paid.etv
number

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

​
tasks.result.items.metrics.paid.count
integer

total count of paid SERPs that contain the domain

​
tasks.result.items.metrics.paid.estimated_paid_traffic_cost
number

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

​
tasks.result.items.metrics.paid.is_new
integer

number of new ranked elements indicates how many new ranked elements were found for the indicated target

​
tasks.result.items.metrics.paid.is_up
integer

rank went up indicates how many ranked elements of the indicated target went up

​
tasks.result.items.metrics.paid.is_down
integer

rank went down indicates how many ranked elements of the indicated target went down

​
tasks.result.items.metrics.paid.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

​
tasks.result.items.metrics.paid.clickstream_etv
integer

estimated traffic volume based on clickstream data calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

​
tasks.result.items.metrics.paid.clickstream_gender_distribution
object

distribution of estimated clickstream-based metrics by gender to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

​
tasks.result.items.metrics.paid.female
integer

number of female users in the relevant clickstream dataset

​
tasks.result.items.metrics.paid.male
integer

number of male users in the relevant clickstream dataset

​
tasks.result.items.metrics.paid.clickstream_age_distribution
object

distribution of clickstream-based metrics by age to retrieve results for this field, the parameter include_clickstream_data must be set to true learn more about how the metric is calculated in this help center article

​
tasks.result.items.metrics.paid.18-24
integer

number of users in the relevant clickstream dataset that fall within the 18-24 age range

​
tasks.result.items.metrics.paid.25-34
integer

number of users in the relevant clickstream dataset that fall within the 25-34 age range

​
tasks.result.items.metrics.paid.35-44
integer

number of users in the relevant clickstream dataset that fall within the 35-44 age range

​
tasks.result.items.metrics.paid.45-54
integer

number of users in the relevant clickstream dataset that fall within the 45-54 age range

​
tasks.result.items.metrics.paid.55-64
integer

number of users in the relevant clickstream dataset that fall within the 55-64 age range