データ 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.

パラメータ

パス・クエリ・ヘッダーのパラメータはありません。

リクエストボディ

targetstring必須
domain required field the domain name of the target website the domain should be specified without https:// and www.
location_namestring任意
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_codeinteger任意
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_namestring任意
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_codestring任意
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[]任意
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_databoolean任意
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_modestring任意
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_synonymsboolean任意
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
filtersarray任意
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[]任意
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
limitinteger任意
the maximum number of returned keywords optional field default value: 100 maximum value: 1000
offsetinteger任意
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
tagstring任意
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

リクエスト例

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>"
}'

レスポンス

レスポンスのフィールド

versionstring任意
the current version of the API
status_codeinteger任意
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_messagestring任意
general informational message you can find the full list of general informational messages here
timestring任意
execution time, seconds
costnumber任意
total tasks cost, USD
tasks_countinteger任意
the number of tasks in the tasks array
tasks_errorinteger任意
the number of tasks in the tasks array returned with an error
tasksstring[]任意
array of tasks
idstring任意
task identifier unique task identifier in our system in the UUID format
status_codeinteger任意
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_messagestring任意
informational message of the task you can find the full list of general informational messages here
timestring任意
execution time, seconds
costnumber任意
cost of the task, USD
result_countinteger任意
number of elements in the result array
pathstring[]任意
URL path
dataobject任意
contains the same parameters that you specified in the POST request
resultstring[]任意
array of results
se_typestring任意
search engine type
targetstring任意
domain in a POST array
location_codeinteger任意
location code in a POST array
language_codestring任意
language code in a POST array
total_countinteger任意
total amount of results in our database relevant to your request
items_countinteger任意
the number of results returned in the items array
itemsstring[]任意
contains subdomains and related data
se_typestring任意
search engine type
subdomainstring任意
returned subdomain
metricsobject任意
ranking data relevant to subdomain
organicobject任意
ranking and traffic data from organic search
pos_1integer任意
number of organic SERPs where the domain ranks #1
pos_2_3integer任意
number of organic SERPs where the domain ranks #2-3
pos_4_10integer任意
number of organic SERPs where the domain ranks #4-10
pos_11_20integer任意
number of organic SERPs where the domain ranks #11-20
pos_21_30integer任意
number of organic SERPs where the domain ranks #21-30
pos_31_40integer任意
number of organic SERPs where the domain ranks #31-40
pos_41_50integer任意
number of organic SERPs where the domain ranks #41-50
pos_51_60integer任意
number of organic SERPs where the domain ranks #51-60
pos_61_70integer任意
number of organic SERPs where the domain ranks #61-70
pos_71_80integer任意
number of organic SERPs where the domain ranks #71-80
pos_81_90integer任意
number of organic SERPs where the domain ranks #81-90
pos_91_100integer任意
number of organic SERPs where the domain ranks #91-100
etvnumber任意
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
countinteger任意
total count of organic SERPs that contain the domain
estimated_paid_traffic_costnumber任意
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_newinteger任意
number of new ranked elements indicates how many new ranked elements were found for the indicated target
is_upinteger任意
rank went up indicates how many ranked elements of the indicated target went up
is_downinteger任意
rank went down indicates how many ranked elements of the indicated target went down
is_lostinteger任意
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_etvinteger任意
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_distributionobject任意
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
femaleinteger任意
number of female users in the relevant clickstream dataset
maleinteger任意
number of male users in the relevant clickstream dataset
clickstream_age_distributionobject任意
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-24integer任意
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34integer任意
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44integer任意
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54integer任意
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64integer任意
number of users in the relevant clickstream dataset that fall within the 55-64 age range
paidobject任意
ranking and traffic data from paid search
pos_1integer任意
number of paid SERPs where the domain ranks #1
pos_2_3integer任意
number of paid SERPs where the domain ranks #2-3
pos_4_10integer任意
number of paid SERPs where the domain ranks #4-10
pos_11_20integer任意
number of paid SERPs where the domain ranks #11-20
pos_21_30integer任意
number of paid SERPs where the domain ranks #21-30
pos_31_40integer任意
number of paid SERPs where the domain ranks #31-40
pos_41_50integer任意
number of paid SERPs where the domain ranks #41-50
pos_51_60integer任意
number of paid SERPs where the domain ranks #51-60
pos_61_70integer任意
number of paid SERPs where the domain ranks #61-70
pos_71_80integer任意
number of paid SERPs where the domain ranks #71-80
pos_81_90integer任意
number of paid SERPs where the domain ranks #81-90
pos_91_100integer任意
number of paid SERPs where the domain ranks #91-100
etvnumber任意
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
countinteger任意
total count of paid SERPs that contain the domain
estimated_paid_traffic_costnumber任意
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_newinteger任意
number of new ranked elements indicates how many new ranked elements were found for the indicated target
is_upinteger任意
rank went up indicates how many ranked elements of the indicated target went up
is_downinteger任意
rank went down indicates how many ranked elements of the indicated target went down
is_lostinteger任意
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_etvinteger任意
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_distributionobject任意
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
femaleinteger任意
number of female users in the relevant clickstream dataset
maleinteger任意
number of male users in the relevant clickstream dataset
clickstream_age_distributionobject任意
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-24integer任意
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34integer任意
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44integer任意
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54integer任意
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64integer任意
number of users in the relevant clickstream dataset that fall within the 55-64 age range
featured_snippetobject任意
ranking and traffic data from the featured snippet results in Google SERP
pos_1integer任意
number of featured snippet items where the domain ranks #1
pos_2_3integer任意
number of featured snippet items where the domain ranks #2-3
pos_4_10integer任意
number of featured snippet items where the domain ranks #4-10
pos_11_20integer任意
number of featured snippet items where the domain ranks #11-20
pos_21_30integer任意
number of featured snippet items where the domain ranks #21-30
pos_31_40integer任意
number of featured snippet items where the domain ranks #31-40
pos_41_50integer任意
number of featured snippet items where the domain ranks #41-50
pos_51_60integer任意
number of featured snippet items where the domain ranks #51-60
pos_61_70integer任意
number of featured snippet items where the domain ranks #61-70
pos_71_80integer任意
number of featured snippet items where the domain ranks #71-80
pos_81_90integer任意
number of featured snippet items where the domain ranks #81-90
pos_91_100integer任意
number of featured snippet items where the domain ranks #91-100
etvnumber任意
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
countinteger任意
total count of featured snippet items that contain the domain
estimated_paid_traffic_costnumber任意
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_newinteger任意
number of new ranked elements indicates how many new ranked elements were found for the indicated target
is_upinteger任意
rank went up indicates how many ranked elements of the indicated target went up
is_downinteger任意
rank went down indicates how many ranked elements of the indicated target went down
is_lostinteger任意
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_etvinteger任意
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_distributionobject任意
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
femaleinteger任意
number of female users in the relevant clickstream dataset
maleinteger任意
number of male users in the relevant clickstream dataset
clickstream_age_distributionobject任意
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-24integer任意
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34integer任意
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44integer任意
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54integer任意
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64integer任意
number of users in the relevant clickstream dataset that fall within the 55-64 age range
local_packobject任意
ranking and traffic data from the local pack results in SERP
pos_1integer任意
number of local pack items where the domain ranks #1
pos_2_3integer任意
number of local pack items where the domain ranks #2-3
pos_4_10integer任意
number of local pack items where the domain ranks #4-10
pos_11_20integer任意
number of local pack items where the domain ranks #11-20
pos_21_30integer任意
number of local pack items where the domain ranks #21-30
pos_31_40integer任意
number of local pack items where the domain ranks #31-40
pos_41_50integer任意
number of local pack items where the domain ranks #41-50
pos_51_60integer任意
number of local pack items where the domain ranks #51-60
pos_61_70integer任意
number of local pack items where the domain ranks #61-70
pos_71_80integer任意
number of local pack items where the domain ranks #71-80
pos_81_90integer任意
number of local pack items where the domain ranks #81-90
pos_91_100integer任意
number of local pack items where the domain ranks #91-100
etvnumber任意
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
countinteger任意
total count of local pack items that contain the domain
estimated_paid_traffic_costnumber任意
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_newinteger任意
number of new ranked elements indicates how many new ranked elements were found for the indicated target
is_upinteger任意
rank went up indicates how many ranked elements of the indicated target went up
is_downinteger任意
rank went down indicates how many ranked elements of the indicated target went down
is_lostinteger任意
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_etvinteger任意
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_distributionobject任意
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
femaleinteger任意
number of female users in the relevant clickstream dataset
maleinteger任意
number of male users in the relevant clickstream dataset
clickstream_age_distributionobject任意
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-24integer任意
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34integer任意
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44integer任意
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54integer任意
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64integer任意
number of users in the relevant clickstream dataset that fall within the 55-64 age range