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 |
se_type |
string |
search engine type |
target |
string |
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 subdomains and related data |
se_type |
string |
search engine type |
subdomain |
string |
returned subdomain |
metrics |
object |
ranking data relevant to subdomain |
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 in the category that 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 (USD) of running ads for all keywords in the category 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
|
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
|
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
|
female |
integer |
number of female users in the relevant clickstream dataset
|
male |
integer |
number of male users in the relevant clickstream dataset
|
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
|
18-24 |
integer |
number of users in the relevant clickstream dataset that fall within the 18-24 age range
|
25-34 |
integer |
number of users in the relevant clickstream dataset that fall within the 25-34 age range
|
35-44 |
integer |
number of users in the relevant clickstream dataset that fall within the 35-44 age range
|
45-54 |
integer |
number of users in the relevant clickstream dataset that fall within the 45-54 age range
|
55-64 |
integer |
number of users in the relevant clickstream dataset that fall within the 55-64 age range
|
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 in the category that 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 of all keywords in the category that the domain ranks for
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
|
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
|
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
|
female |
integer |
number of female users in the relevant clickstream dataset
|
male |
integer |
number of male users in the relevant clickstream dataset
|
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
|
18-24 |
integer |
number of users in the relevant clickstream dataset that fall within the 18-24 age range
|
25-34 |
integer |
number of users in the relevant clickstream dataset that fall within the 25-34 age range
|
35-44 |
integer |
number of users in the relevant clickstream dataset that fall within the 35-44 age range
|
45-54 |
integer |
number of users in the relevant clickstream dataset that fall within the 45-54 age range
|
55-64 |
integer |
number of users in the relevant clickstream dataset that fall within the 55-64 age range
|
featured_snippet |
object |
ranking and traffic data from the featured snippet results in Google SERP |
pos_1 |
integer |
number of featured snippet items where the domain ranks #1 |
pos_2_3 |
integer |
number of featured snippet items where the domain ranks #2-3 |
pos_4_10 |
integer |
number of featured snippet items where the domain ranks #4-10 |
pos_11_20 |
integer |
number of featured snippet items where the domain ranks #11-20 |
pos_21_30 |
integer |
number of featured snippet items where the domain ranks #21-30 |
pos_31_40 |
integer |
number of featured snippet items where the domain ranks #31-40 |
pos_41_50 |
integer |
number of featured snippet items where the domain ranks #41-50 |
pos_51_60 |
integer |
number of featured snippet items where the domain ranks #51-60 |
pos_61_70 |
integer |
number of featured snippet items where the domain ranks #61-70 |
pos_71_80 |
integer |
number of featured snippet items where the domain ranks #71-80 |
pos_81_90 |
integer |
number of featured snippet items where the domain ranks #81-90 |
pos_91_100 |
integer |
number of featured snippet items 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 in the category that the domain ranks for
learn more about how the metric is calculated in this help center article |
count |
integer |
total count of featured snippet items 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 of all keywords in the category that the domain ranks for
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
|
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
|
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
|
female |
integer |
number of female users in the relevant clickstream dataset
|
male |
integer |
number of male users in the relevant clickstream dataset
|
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
|
18-24 |
integer |
number of users in the relevant clickstream dataset that fall within the 18-24 age range
|
25-34 |
integer |
number of users in the relevant clickstream dataset that fall within the 25-34 age range
|
35-44 |
integer |
number of users in the relevant clickstream dataset that fall within the 35-44 age range
|
45-54 |
integer |
number of users in the relevant clickstream dataset that fall within the 45-54 age range
|
55-64 |
integer |
number of users in the relevant clickstream dataset that fall within the 55-64 age range
|
local_pack |
object |
ranking and traffic data from the local pack results in SERP |
pos_1 |
integer |
number of local pack items where the domain ranks #1 |
pos_2_3 |
integer |
number of local pack items where the domain ranks #2-3 |
pos_4_10 |
integer |
number of local pack items where the domain ranks #4-10 |
pos_11_20 |
integer |
number of local pack items where the domain ranks #11-20 |
pos_21_30 |
integer |
number of local pack items where the domain ranks #21-30 |
pos_31_40 |
integer |
number of local pack items where the domain ranks #31-40 |
pos_41_50 |
integer |
number of local pack items where the domain ranks #41-50 |
pos_51_60 |
integer |
number of local pack items where the domain ranks #51-60 |
pos_61_70 |
integer |
number of local pack items where the domain ranks #61-70 |
pos_71_80 |
integer |
number of local pack items where the domain ranks #71-80 |
pos_81_90 |
integer |
number of local pack items where the domain ranks #81-90 |
pos_91_100 |
integer |
number of local pack items 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 in the category that the domain ranks for
learn more about how the metric is calculated in this help center article |
count |
integer |
total count of local pack items 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 of all keywords in the category that the domain ranks for
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
|
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
|
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
|
female |
integer |
number of female users in the relevant clickstream dataset
|
male |
integer |
number of male users in the relevant clickstream dataset
|
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
|
18-24 |
integer |
number of users in the relevant clickstream dataset that fall within the 18-24 age range
|
25-34 |
integer |
number of users in the relevant clickstream dataset that fall within the 25-34 age range
|
35-44 |
integer |
number of users in the relevant clickstream dataset that fall within the 35-44 age range
|
45-54 |
integer |
number of users in the relevant clickstream dataset that fall within the 45-54 age range
|
55-64 |
integer |
number of users in the relevant clickstream dataset that fall within the 55-64 age range
|