Data API / DataForSEO / DataForSEO Labs

Subdomains

The subdomains of a target and the search footprint of each. Pages with limit, offset and offset_token; use the token past the first pages. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Useful when a domain's traffic is concentrated somewhere other than www - a docs or blog subdomain carrying the site is invisible in post_dataforseo_labs_google_domain_rank_overview_live.

Parameters

No path, query, or header parameters.

Request body

targetstringRequired
domain required field the domain name of the target website the domain should be specified without https:// and www.
location_namestringOptional
full name of the location optional field if you use this field, you don’t need to specify 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 ignore this field to get the results for all available locations example: United Kingdom
location_codeintegerOptional
location code optional field if you use this field, you don’t need to specify location_name 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 ignore this field to get the results for all available locations example: 2840
language_namestringOptional
full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: English
language_codestringOptional
language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available languages example: en
item_typesstring[]Optional
display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response; possible values: ["organic", "paid", "featured_snippet", "local_pack"] default value: ["organic", "paid"]
include_clickstream_databooleanOptional
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 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
historical_serp_modestringOptional
data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live
ignore_synonymsbooleanOptional
ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false
filtersarrayOptional
array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , , >, >=, =, , in, not_in example: ["metrics.paid.count",">",0] [["metrics.paid.count",">",0],"and",["metrics.paid.etv",">","50"]] [["metrics.organic.count",">","10"], "and", [["metrics.organic.pos_1","",0],"or",["metrics.organic.pos_2_3","",0]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
order_bystring[]Optional
results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to specify a sorting type example: ["metrics.paid.etv,asc"] Note: you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["metrics.organic.etv,desc","metrics.paid.count,asc"] default rule: ["metrics.organic.count,desc"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
limitintegerOptional
the maximum number of returned keywords optional field default value: 100 maximum value: 1000
offsetintegerOptional
offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
tagstringOptional
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

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/subdomains/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "item_types": [
    "<string>"
  ],
  "include_clickstream_data": false,
  "historical_serp_mode": "<string>"
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
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_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array returned with an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
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_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
se_typestringOptional
search engine type
targetstringOptional
domain in a POST array
location_codeintegerOptional
location code in a POST array
language_codestringOptional
language code in a POST array
total_countintegerOptional
total amount of results in our database relevant to your request
items_countintegerOptional
the number of results returned in the items array
itemsstring[]Optional
contains subdomains and related data
se_typestringOptional
search engine type
subdomainstringOptional
returned subdomain
metricsobjectOptional
ranking data relevant to subdomain
organicobjectOptional
ranking and traffic data from organic search
pos_1integerOptional
number of organic SERPs where the domain ranks #1
pos_2_3integerOptional
number of organic SERPs where the domain ranks #2-3
pos_4_10integerOptional
number of organic SERPs where the domain ranks #4-10
pos_11_20integerOptional
number of organic SERPs where the domain ranks #11-20
pos_21_30integerOptional
number of organic SERPs where the domain ranks #21-30
pos_31_40integerOptional
number of organic SERPs where the domain ranks #31-40
pos_41_50integerOptional
number of organic SERPs where the domain ranks #41-50
pos_51_60integerOptional
number of organic SERPs where the domain ranks #51-60
pos_61_70integerOptional
number of organic SERPs where the domain ranks #61-70
pos_71_80integerOptional
number of organic SERPs where the domain ranks #71-80
pos_81_90integerOptional
number of organic SERPs where the domain ranks #81-90
pos_91_100integerOptional
number of organic SERPs where the domain ranks #91-100
etvnumberOptional
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
countintegerOptional
total count of organic SERPs that contain the domain
estimated_paid_traffic_costnumberOptional
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_newintegerOptional
number of new ranked elements indicates how many new ranked elements were found for the indicated target
is_upintegerOptional
rank went up indicates how many ranked elements of the indicated target went up
is_downintegerOptional
rank went down indicates how many ranked elements of the indicated target went down
is_lostintegerOptional
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_etvintegerOptional
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_distributionobjectOptional
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
femaleintegerOptional
number of female users in the relevant clickstream dataset
maleintegerOptional
number of male users in the relevant clickstream dataset
clickstream_age_distributionobjectOptional
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-24integerOptional
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34integerOptional
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44integerOptional
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54integerOptional
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64integerOptional
number of users in the relevant clickstream dataset that fall within the 55-64 age range
paidobjectOptional
ranking and traffic data from paid search
pos_1integerOptional
number of paid SERPs where the domain ranks #1
pos_2_3integerOptional
number of paid SERPs where the domain ranks #2-3
pos_4_10integerOptional
number of paid SERPs where the domain ranks #4-10
pos_11_20integerOptional
number of paid SERPs where the domain ranks #11-20
pos_21_30integerOptional
number of paid SERPs where the domain ranks #21-30
pos_31_40integerOptional
number of paid SERPs where the domain ranks #31-40
pos_41_50integerOptional
number of paid SERPs where the domain ranks #41-50
pos_51_60integerOptional
number of paid SERPs where the domain ranks #51-60
pos_61_70integerOptional
number of paid SERPs where the domain ranks #61-70
pos_71_80integerOptional
number of paid SERPs where the domain ranks #71-80
pos_81_90integerOptional
number of paid SERPs where the domain ranks #81-90
pos_91_100integerOptional
number of paid SERPs where the domain ranks #91-100
etvnumberOptional
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
countintegerOptional
total count of paid SERPs that contain the domain
estimated_paid_traffic_costnumberOptional
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_newintegerOptional
number of new ranked elements indicates how many new ranked elements were found for the indicated target
is_upintegerOptional
rank went up indicates how many ranked elements of the indicated target went up
is_downintegerOptional
rank went down indicates how many ranked elements of the indicated target went down
is_lostintegerOptional
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_etvintegerOptional
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_distributionobjectOptional
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
femaleintegerOptional
number of female users in the relevant clickstream dataset
maleintegerOptional
number of male users in the relevant clickstream dataset
clickstream_age_distributionobjectOptional
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-24integerOptional
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34integerOptional
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44integerOptional
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54integerOptional
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64integerOptional
number of users in the relevant clickstream dataset that fall within the 55-64 age range
featured_snippetobjectOptional
ranking and traffic data from the featured snippet results in Google SERP
pos_1integerOptional
number of featured snippet items where the domain ranks #1
pos_2_3integerOptional
number of featured snippet items where the domain ranks #2-3
pos_4_10integerOptional
number of featured snippet items where the domain ranks #4-10
pos_11_20integerOptional
number of featured snippet items where the domain ranks #11-20
pos_21_30integerOptional
number of featured snippet items where the domain ranks #21-30
pos_31_40integerOptional
number of featured snippet items where the domain ranks #31-40
pos_41_50integerOptional
number of featured snippet items where the domain ranks #41-50
pos_51_60integerOptional
number of featured snippet items where the domain ranks #51-60
pos_61_70integerOptional
number of featured snippet items where the domain ranks #61-70
pos_71_80integerOptional
number of featured snippet items where the domain ranks #71-80
pos_81_90integerOptional
number of featured snippet items where the domain ranks #81-90
pos_91_100integerOptional
number of featured snippet items where the domain ranks #91-100
etvnumberOptional
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
countintegerOptional
total count of featured snippet items that contain the domain
estimated_paid_traffic_costnumberOptional
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_newintegerOptional
number of new ranked elements indicates how many new ranked elements were found for the indicated target
is_upintegerOptional
rank went up indicates how many ranked elements of the indicated target went up
is_downintegerOptional
rank went down indicates how many ranked elements of the indicated target went down
is_lostintegerOptional
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_etvintegerOptional
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_distributionobjectOptional
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
femaleintegerOptional
number of female users in the relevant clickstream dataset
maleintegerOptional
number of male users in the relevant clickstream dataset
clickstream_age_distributionobjectOptional
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-24integerOptional
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34integerOptional
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44integerOptional
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54integerOptional
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64integerOptional
number of users in the relevant clickstream dataset that fall within the 55-64 age range
local_packobjectOptional
ranking and traffic data from the local pack results in SERP
pos_1integerOptional
number of local pack items where the domain ranks #1
pos_2_3integerOptional
number of local pack items where the domain ranks #2-3
pos_4_10integerOptional
number of local pack items where the domain ranks #4-10
pos_11_20integerOptional
number of local pack items where the domain ranks #11-20
pos_21_30integerOptional
number of local pack items where the domain ranks #21-30
pos_31_40integerOptional
number of local pack items where the domain ranks #31-40
pos_41_50integerOptional
number of local pack items where the domain ranks #41-50
pos_51_60integerOptional
number of local pack items where the domain ranks #51-60
pos_61_70integerOptional
number of local pack items where the domain ranks #61-70
pos_71_80integerOptional
number of local pack items where the domain ranks #71-80
pos_81_90integerOptional
number of local pack items where the domain ranks #81-90
pos_91_100integerOptional
number of local pack items where the domain ranks #91-100
etvnumberOptional
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
countintegerOptional
total count of local pack items that contain the domain
estimated_paid_traffic_costnumberOptional
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_newintegerOptional
number of new ranked elements indicates how many new ranked elements were found for the indicated target
is_upintegerOptional
rank went up indicates how many ranked elements of the indicated target went up
is_downintegerOptional
rank went down indicates how many ranked elements of the indicated target went down
is_lostintegerOptional
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_etvintegerOptional
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_distributionobjectOptional
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
femaleintegerOptional
number of female users in the relevant clickstream dataset
maleintegerOptional
number of male users in the relevant clickstream dataset
clickstream_age_distributionobjectOptional
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-24integerOptional
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34integerOptional
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44integerOptional
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54integerOptional
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64integerOptional
number of users in the relevant clickstream dataset that fall within the 55-64 age range