DataForSEO
SEO, search-engine results, keyword research, backlinks and AI visibility data.
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.
- 类型: array object[]
- target类型: string必填
domain required field the domain name of the target website the domain should be specified without https:// and www.
- filters类型: array
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
- historical类型: string
_serp _mode 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类型: boolean
_synonyms 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
- include类型: boolean
_clickstream _data 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
- item类型: array string[]
_types 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"]
- language类型: string
_code 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
- language类型: string
_name 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
- limit类型: integer
the maximum number of returned keywords optional field default value: 100 maximum value: 1000
- location类型: integer
_code 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
- location类型: string
_name 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
- offset类型: integer
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
- order类型: array string[]
_by 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
- 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
- 类型: object200
Successful response
- 类型: numbercost
total tasks cost, USD
- 类型: integerstatus
_code 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
- 类型: stringstatus
_message general informational message you can find the full list of general informational messages here
- 类型: array string[]tasks
array of tasks
- 类型: integertasks
_count the number of tasks in the tasks array
- 类型: integertasks
_error the number of tasks in the tasks array returned with an error
- 类型: numbertasks
.cost cost of the task, USD
- 类型: objecttasks
.data contains the same parameters that you specified in the POST request
- 类型: stringtasks
.id task identifier unique task identifier in our system in the UUID format
- 类型: array string[]tasks
.path URL path
- 类型: array string[]tasks
.result array of results
- 类型: integertasks
.result _count number of elements in the result array
- 类型: array string[]tasks
.result .items contains subdomains and related data
- 类型: integertasks
.result .items _count the number of results returned in the items array
- 类型: objecttasks
.result .items .metrics ranking data relevant to subdomain
- 类型: objecttasks
.result .items .metrics .featured _snippet ranking and traffic data from the featured snippet results in Google SERP
- 类型: objecttasks
.result .items .metrics .featured _snippet .clickstream _age _distribution 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
- 类型: integertasks
.result .items .metrics .featured _snippet .clickstream _age _distribution .18 -24 number of users in the relevant clickstream dataset that fall within the 18-24 age range
- 类型: integertasks
.result .items .metrics .featured _snippet .clickstream _age _distribution .25 -34 number of users in the relevant clickstream dataset that fall within the 25-34 age range
- 类型: integertasks
.result .items .metrics .featured _snippet .clickstream _age _distribution .35 -44 number of users in the relevant clickstream dataset that fall within the 35-44 age range
- 类型: integertasks
.result .items .metrics .featured _snippet .clickstream _age _distribution .45 -54 number of users in the relevant clickstream dataset that fall within the 45-54 age range
- 类型: integertasks
.result .items .metrics .featured _snippet .clickstream _age _distribution .55 -64 number of users in the relevant clickstream dataset that fall within the 55-64 age range
- 类型: integertasks
.result .items .metrics .featured _snippet .clickstream _etv 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
- 类型: objecttasks
.result .items .metrics .featured _snippet .clickstream _gender _distribution 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
- 类型: integertasks
.result .items .metrics .featured _snippet .clickstream _gender _distribution .female number of female users in the relevant clickstream dataset
- 类型: integertasks
.result .items .metrics .featured _snippet .clickstream _gender _distribution .male number of male users in the relevant clickstream dataset
- 类型: integertasks
.result .items .metrics .featured _snippet .count total count of featured snippet items that contain the domain
- 类型: numbertasks
.result .items .metrics .featured _snippet .estimated _paid _traffic _cost 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
- 类型: numbertasks
.result .items .metrics .featured _snippet .etv 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
- 类型: integertasks
.result .items .metrics .featured _snippet .is _down rank went down indicates how many ranked elements of the indicated target went down
- 类型: integertasks
.result .items .metrics .featured _snippet .is _lost 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
- 类型: integertasks
.result .items .metrics .featured _snippet .is _new number of new ranked elements indicates how many new ranked elements were found for the indicated target
- 类型: integertasks
.result .items .metrics .featured _snippet .is _up rank went up indicates how many ranked elements of the indicated target went up
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _1 number of featured snippet items where the domain ranks #1
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _11 _20 number of featured snippet items where the domain ranks #11-20
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _2 _3 number of featured snippet items where the domain ranks #2-3
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _21 _30 number of featured snippet items where the domain ranks #21-30
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _31 _40 number of featured snippet items where the domain ranks #31-40
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _4 _10 number of featured snippet items where the domain ranks #4-10
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _41 _50 number of featured snippet items where the domain ranks #41-50
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _51 _60 number of featured snippet items where the domain ranks #51-60
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _61 _70 number of featured snippet items where the domain ranks #61-70
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _71 _80 number of featured snippet items where the domain ranks #71-80
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _81 _90 number of featured snippet items where the domain ranks #81-90
- 类型: integertasks
.result .items .metrics .featured _snippet .pos _91 _100 number of featured snippet items where the domain ranks #91-100
- 类型: objecttasks
.result .items .metrics .local _pack ranking and traffic data from the local pack results in SERP
- 类型: objecttasks
.result .items .metrics .local _pack .clickstream _age _distribution 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
- 类型: integertasks
.result .items .metrics .local _pack .clickstream _age _distribution .18 -24 number of users in the relevant clickstream dataset that fall within the 18-24 age range
- 类型: integertasks
.result .items .metrics .local _pack .clickstream _age _distribution .25 -34 number of users in the relevant clickstream dataset that fall within the 25-34 age range
- 类型: integertasks
.result .items .metrics .local _pack .clickstream _age _distribution .35 -44 number of users in the relevant clickstream dataset that fall within the 35-44 age range
- 类型: integertasks
.result .items .metrics .local _pack .clickstream _age _distribution .45 -54 number of users in the relevant clickstream dataset that fall within the 45-54 age range
- 类型: integertasks
.result .items .metrics .local _pack .clickstream _age _distribution .55 -64 number of users in the relevant clickstream dataset that fall within the 55-64 age range
- 类型: integertasks
.result .items .metrics .local _pack .clickstream _etv 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
- 类型: objecttasks
.result .items .metrics .local _pack .clickstream _gender _distribution 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
- 类型: integertasks
.result .items .metrics .local _pack .clickstream _gender _distribution .female number of female users in the relevant clickstream dataset
- 类型: integertasks
.result .items .metrics .local _pack .clickstream _gender _distribution .male number of male users in the relevant clickstream dataset
- 类型: integertasks
.result .items .metrics .local _pack .count total count of local pack items that contain the domain
- 类型: numbertasks
.result .items .metrics .local _pack .estimated _paid _traffic _cost 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
- 类型: numbertasks
.result .items .metrics .local _pack .etv 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
- 类型: integertasks
.result .items .metrics .local _pack .is _down rank went down indicates how many ranked elements of the indicated target went down
- 类型: integertasks
.result .items .metrics .local _pack .is _lost 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
- 类型: integertasks
.result .items .metrics .local _pack .is _new number of new ranked elements indicates how many new ranked elements were found for the indicated target
- 类型: integertasks
.result .items .metrics .local _pack .is _up rank went up indicates how many ranked elements of the indicated target went up
- 类型: integertasks
.result .items .metrics .local _pack .pos _1 number of local pack items where the domain ranks #1
- 类型: integertasks
.result .items .metrics .local _pack .pos _11 _20 number of local pack items where the domain ranks #11-20
- 类型: integertasks
.result .items .metrics .local _pack .pos _2 _3 number of local pack items where the domain ranks #2-3
- 类型: integertasks
.result .items .metrics .local _pack .pos _21 _30 number of local pack items where the domain ranks #21-30
- 类型: integertasks
.result .items .metrics .local _pack .pos _31 _40 number of local pack items where the domain ranks #31-40
- 类型: integertasks
.result .items .metrics .local _pack .pos _4 _10 number of local pack items where the domain ranks #4-10
- 类型: integertasks
.result .items .metrics .local _pack .pos _41 _50 number of local pack items where the domain ranks #41-50
- 类型: integertasks
.result .items .metrics .local _pack .pos _51 _60 number of local pack items where the domain ranks #51-60
- 类型: integertasks
.result .items .metrics .local _pack .pos _61 _70 number of local pack items where the domain ranks #61-70
- 类型: integertasks
.result .items .metrics .local _pack .pos _71 _80 number of local pack items where the domain ranks #71-80
- 类型: integertasks
.result .items .metrics .local _pack .pos _81 _90 number of local pack items where the domain ranks #81-90
- 类型: integertasks
.result .items .metrics .local _pack .pos _91 _100 number of local pack items where the domain ranks #91-100
- 类型: objecttasks
.result .items .metrics .organic ranking and traffic data from organic search
- 类型: objecttasks
.result .items .metrics .organic .clickstream _age _distribution 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
- 类型: integertasks
.result .items .metrics .organic .clickstream _age _distribution .18 -24 number of users in the relevant clickstream dataset that fall within the 18-24 age range
- 类型: integertasks
.result .items .metrics .organic .clickstream _age _distribution .25 -34 number of users in the relevant clickstream dataset that fall within the 25-34 age range
- 类型: integertasks
.result .items .metrics .organic .clickstream _age _distribution .35 -44 number of users in the relevant clickstream dataset that fall within the 35-44 age range
- 类型: integertasks
.result .items .metrics .organic .clickstream _age _distribution .45 -54 number of users in the relevant clickstream dataset that fall within the 45-54 age range
- 类型: integertasks
.result .items .metrics .organic .clickstream _age _distribution .55 -64 number of users in the relevant clickstream dataset that fall within the 55-64 age range
- 类型: integertasks
.result .items .metrics .organic .clickstream _etv 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
- 类型: objecttasks
.result .items .metrics .organic .clickstream _gender _distribution 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
- 类型: integertasks
.result .items .metrics .organic .clickstream _gender _distribution .female number of female users in the relevant clickstream dataset
- 类型: integertasks
.result .items .metrics .organic .clickstream _gender _distribution .male number of male users in the relevant clickstream dataset
- 类型: integertasks
.result .items .metrics .organic .count total count of organic SERPs that contain the domain
- 类型: numbertasks
.result .items .metrics .organic .estimated _paid _traffic _cost 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
- 类型: numbertasks
.result .items .metrics .organic .etv 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
- 类型: integertasks
.result .items .metrics .organic .is _down rank went down indicates how many ranked elements of the indicated target went down
- 类型: integertasks
.result .items .metrics .organic .is _lost 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
- 类型: integertasks
.result .items .metrics .organic .is _new number of new ranked elements indicates how many new ranked elements were found for the indicated target
- 类型: integertasks
.result .items .metrics .organic .is _up rank went up indicates how many ranked elements of the indicated target went up
- 类型: integertasks
.result .items .metrics .organic .pos _1 number of organic SERPs where the domain ranks #1
- 类型: integertasks
.result .items .metrics .organic .pos _11 _20 number of organic SERPs where the domain ranks #11-20
- 类型: integertasks
.result .items .metrics .organic .pos _2 _3 number of organic SERPs where the domain ranks #2-3
- 类型: integertasks
.result .items .metrics .organic .pos _21 _30 number of organic SERPs where the domain ranks #21-30
- 类型: integertasks
.result .items .metrics .organic .pos _31 _40 number of organic SERPs where the domain ranks #31-40
- 类型: integertasks
.result .items .metrics .organic .pos _4 _10 number of organic SERPs where the domain ranks #4-10
- 类型: integertasks
.result .items .metrics .organic .pos _41 _50 number of organic SERPs where the domain ranks #41-50
- 类型: integertasks
.result .items .metrics .organic .pos _51 _60 number of organic SERPs where the domain ranks #51-60
- 类型: integertasks
.result .items .metrics .organic .pos _61 _70 number of organic SERPs where the domain ranks #61-70
- 类型: integertasks
.result .items .metrics .organic .pos _71 _80 number of organic SERPs where the domain ranks #71-80
- 类型: integertasks
.result .items .metrics .organic .pos _81 _90 number of organic SERPs where the domain ranks #81-90
- 类型: integertasks
.result .items .metrics .organic .pos _91 _100 number of organic SERPs where the domain ranks #91-100
- 类型: objecttasks
.result .items .metrics .paid ranking and traffic data from paid search
- 类型: objecttasks
.result .items .metrics .paid .clickstream _age _distribution 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
- 类型: integertasks
.result .items .metrics .paid .clickstream _age _distribution .18 -24 number of users in the relevant clickstream dataset that fall within the 18-24 age range
- 类型: integertasks
.result .items .metrics .paid .clickstream _age _distribution .25 -34 number of users in the relevant clickstream dataset that fall within the 25-34 age range
- 类型: integertasks
.result .items .metrics .paid .clickstream _age _distribution .35 -44 number of users in the relevant clickstream dataset that fall within the 35-44 age range
- 类型: integertasks
.result .items .metrics .paid .clickstream _age _distribution .45 -54 number of users in the relevant clickstream dataset that fall within the 45-54 age range
- 类型: integertasks
.result .items .metrics .paid .clickstream _age _distribution .55 -64 number of users in the relevant clickstream dataset that fall within the 55-64 age range
- 类型: integertasks
.result .items .metrics .paid .clickstream _etv 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
- 类型: objecttasks
.result .items .metrics .paid .clickstream _gender _distribution 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
- 类型: integertasks
.result .items .metrics .paid .clickstream _gender _distribution .female number of female users in the relevant clickstream dataset
- 类型: integertasks
.result .items .metrics .paid .clickstream _gender _distribution .male number of male users in the relevant clickstream dataset
- 类型: integertasks
.result .items .metrics .paid .count total count of paid SERPs that contain the domain
- 类型: numbertasks
.result .items .metrics .paid .estimated _paid _traffic _cost 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
- 类型: numbertasks
.result .items .metrics .paid .etv 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
- 类型: integertasks
.result .items .metrics .paid .is _down rank went down indicates how many ranked elements of the indicated target went down
- 类型: integertasks
.result .items .metrics .paid .is _lost 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
- 类型: integertasks
.result .items .metrics .paid .is _new number of new ranked elements indicates how many new ranked elements were found for the indicated target
- 类型: integertasks
.result .items .metrics .paid .is _up rank went up indicates how many ranked elements of the indicated target went up
- 类型: integertasks
.result .items .metrics .paid .pos _1 number of paid SERPs where the domain ranks #1
- 类型: integertasks
.result .items .metrics .paid .pos _11 _20 number of paid SERPs where the domain ranks #11-20
- 类型: integertasks
.result .items .metrics .paid .pos _2 _3 number of paid SERPs where the domain ranks #2-3
- 类型: integertasks
.result .items .metrics .paid .pos _21 _30 number of paid SERPs where the domain ranks #21-30
- 类型: integertasks
.result .items .metrics .paid .pos _31 _40 number of paid SERPs where the domain ranks #31-40
- 类型: integertasks
.result .items .metrics .paid .pos _4 _10 number of paid SERPs where the domain ranks #4-10
- 类型: integertasks
.result .items .metrics .paid .pos _41 _50 number of paid SERPs where the domain ranks #41-50
- 类型: integertasks
.result .items .metrics .paid .pos _51 _60 number of paid SERPs where the domain ranks #51-60
- 类型: integertasks
.result .items .metrics .paid .pos _61 _70 number of paid SERPs where the domain ranks #61-70
- 类型: integertasks
.result .items .metrics .paid .pos _71 _80 number of paid SERPs where the domain ranks #71-80
- 类型: integertasks
.result .items .metrics .paid .pos _81 _90 number of paid SERPs where the domain ranks #81-90
- 类型: integertasks
.result .items .metrics .paid .pos _91 _100 number of paid SERPs where the domain ranks #91-100
- 类型: stringtasks
.result .items .se _type search engine type
- 类型: stringtasks
.result .items .subdomain returned subdomain
- 类型: stringtasks
.result .language _code language code in a POST array
- 类型: integertasks
.result .location _code location code in a POST array
- 类型: stringtasks
.result .se _type search engine type
- 类型: stringtasks
.result .target domain in a POST array
- 类型: integertasks
.result .total _count total amount of results in our database relevant to your request
- 类型: integertasks
.status _code 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
- 类型: stringtasks
.status _message informational message of the task you can find the full list of general informational messages here
- 类型: stringtasks
.time execution time, seconds
- 类型: stringtime
execution time, seconds
- 类型: stringversion
the current version of the API
application/json - 400
Bad request
- 401
Unauthorized
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
Rate limit exceeded
- 500
Internal server error
- 502
The service could not complete the request.
- 503
The API or billing service is temporarily unavailable.
- 504
The service timed out while processing the request.
- default
The operation failed. Keep the response request ID when contacting Felo support.
curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/subdomains/live \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '[
{
"target": "",
"location_name": "",
"location_code": 1,
"language_name": "",
"language_code": "",
"item_types": [
""
],
"include_clickstream_data": true,
"historical_serp_mode": "",
"ignore_synonyms": true,
"filters": [],
"order_by": [
""
],
"limit": 1,
"offset": 1,
"tag": ""
}
]'
{
"version": "string",
"status_code": 1,
"status_message": "string",
"time": "string",
"cost": 1,
"tasks_count": 1,
"tasks_error": 1,
"tasks": [
"string"
],
"tasks.id": "string",
"tasks.status_code": 1,
"tasks.status_message": "string",
"tasks.time": "string",
"tasks.cost": 1,
"tasks.result_count": 1,
"tasks.path": [
"string"
],
"tasks.data": {},
"tasks.result": [
"string"
],
"tasks.result.se_type": "string",
"tasks.result.target": "string",
"tasks.result.location_code": 1,
"tasks.result.language_code": "string",
"tasks.result.total_count": 1,
"tasks.result.items_count": 1,
"tasks.result.items": [
"string"
],
"tasks.result.items.se_type": "string",
"tasks.result.items.subdomain": "string",
"tasks.result.items.metrics": {},
"tasks.result.items.metrics.organic": {},
"tasks.result.items.metrics.organic.pos_1": 1,
"tasks.result.items.metrics.organic.pos_2_3": 1,
"tasks.result.items.metrics.organic.pos_4_10": 1,
"tasks.result.items.metrics.organic.pos_11_20": 1,
"tasks.result.items.metrics.organic.pos_21_30": 1,
"tasks.result.items.metrics.organic.pos_31_40": 1,
"tasks.result.items.metrics.organic.pos_41_50": 1,
"tasks.result.items.metrics.organic.pos_51_60": 1,
"tasks.result.items.metrics.organic.pos_61_70": 1,
"tasks.result.items.metrics.organic.pos_71_80": 1,
"tasks.result.items.metrics.organic.pos_81_90": 1,
"tasks.result.items.metrics.organic.pos_91_100": 1,
"tasks.result.items.metrics.organic.etv": 1,
"tasks.result.items.metrics.organic.count": 1,
"tasks.result.items.metrics.organic.estimated_paid_traffic_cost": 1,
"tasks.result.items.metrics.organic.is_new": 1,
"tasks.result.items.metrics.organic.is_up": 1,
"tasks.result.items.metrics.organic.is_down": 1,
"tasks.result.items.metrics.organic.is_lost": 1,
"tasks.result.items.metrics.organic.clickstream_etv": 1,
"tasks.result.items.metrics.organic.clickstream_gender_distribution": {},
"tasks.result.items.metrics.organic.clickstream_gender_distribution.female": 1,
"tasks.result.items.metrics.organic.clickstream_gender_distribution.male": 1,
"tasks.result.items.metrics.organic.clickstream_age_distribution": {},
"tasks.result.items.metrics.organic.clickstream_age_distribution.18-24": 1,
"tasks.result.items.metrics.organic.clickstream_age_distribution.25-34": 1,
"tasks.result.items.metrics.organic.clickstream_age_distribution.35-44": 1,
"tasks.result.items.metrics.organic.clickstream_age_distribution.45-54": 1,
"tasks.result.items.metrics.organic.clickstream_age_distribution.55-64": 1,
"tasks.result.items.metrics.paid": {},
"tasks.result.items.metrics.paid.pos_1": 1,
"tasks.result.items.metrics.paid.pos_2_3": 1,
"tasks.result.items.metrics.paid.pos_4_10": 1,
"tasks.result.items.metrics.paid.pos_11_20": 1,
"tasks.result.items.metrics.paid.pos_21_30": 1,
"tasks.result.items.metrics.paid.pos_31_40": 1,
"tasks.result.items.metrics.paid.pos_41_50": 1,
"tasks.result.items.metrics.paid.pos_51_60": 1,
"tasks.result.items.metrics.paid.pos_61_70": 1,
"tasks.result.items.metrics.paid.pos_71_80": 1,
"tasks.result.items.metrics.paid.pos_81_90": 1,
"tasks.result.items.metrics.paid.pos_91_100": 1,
"tasks.result.items.metrics.paid.etv": 1,
"tasks.result.items.metrics.paid.count": 1,
"tasks.result.items.metrics.paid.estimated_paid_traffic_cost": 1,
"tasks.result.items.metrics.paid.is_new": 1,
"tasks.result.items.metrics.paid.is_up": 1,
"tasks.result.items.metrics.paid.is_down": 1,
"tasks.result.items.metrics.paid.is_lost": 1,
"tasks.result.items.metrics.paid.clickstream_etv": 1,
"tasks.result.items.metrics.paid.clickstream_gender_distribution": {},
"tasks.result.items.metrics.paid.clickstream_gender_distribution.female": 1,
"tasks.result.items.metrics.paid.clickstream_gender_distribution.male": 1,
"tasks.result.items.metrics.paid.clickstream_age_distribution": {},
"tasks.result.items.metrics.paid.clickstream_age_distribution.18-24": 1,
"tasks.result.items.metrics.paid.clickstream_age_distribution.25-34": 1,
"tasks.result.items.metrics.paid.clickstream_age_distribution.35-44": 1,
"tasks.result.items.metrics.paid.clickstream_age_distribution.45-54": 1,
"tasks.result.items.metrics.paid.clickstream_age_distribution.55-64": 1,
"tasks.result.items.metrics.featured_snippet": {},
"tasks.result.items.metrics.featured_snippet.pos_1": 1,
"tasks.result.items.metrics.featured_snippet.pos_2_3": 1,
"tasks.result.items.metrics.featured_snippet.pos_4_10": 1,
"tasks.result.items.metrics.featured_snippet.pos_11_20": 1,
"tasks.result.items.metrics.featured_snippet.pos_21_30": 1,
"tasks.result.items.metrics.featured_snippet.pos_31_40": 1,
"tasks.result.items.metrics.featured_snippet.pos_41_50": 1,
"tasks.result.items.metrics.featured_snippet.pos_51_60": 1,
"tasks.result.items.metrics.featured_snippet.pos_61_70": 1,
"tasks.result.items.metrics.featured_snippet.pos_71_80": 1,
"tasks.result.items.metrics.featured_snippet.pos_81_90": 1,
"tasks.result.items.metrics.featured_snippet.pos_91_100": 1,
"tasks.result.items.metrics.featured_snippet.etv": 1,
"tasks.result.items.metrics.featured_snippet.count": 1,
"tasks.result.items.metrics.featured_snippet.estimated_paid_traffic_cost": 1,
"tasks.result.items.metrics.featured_snippet.is_new": 1,
"tasks.result.items.metrics.featured_snippet.is_up": 1,
"tasks.result.items.metrics.featured_snippet.is_down": 1,
"tasks.result.items.metrics.featured_snippet.is_lost": 1,
"tasks.result.items.metrics.featured_snippet.clickstream_etv": 1,
"tasks.result.items.metrics.featured_snippet.clickstream_gender_distribution": {},
"tasks.result.items.metrics.featured_snippet.clickstream_gender_distribution.female": 1,
"tasks.result.items.metrics.featured_snippet.clickstream_gender_distribution.male": 1,
"tasks.result.items.metrics.featured_snippet.clickstream_age_distribution": {},
"tasks.result.items.metrics.featured_snippet.clickstream_age_distribution.18-24": 1,
"tasks.result.items.metrics.featured_snippet.clickstream_age_distribution.25-34": 1,
"tasks.result.items.metrics.featured_snippet.clickstream_age_distribution.35-44": 1,
"tasks.result.items.metrics.featured_snippet.clickstream_age_distribution.45-54": 1,
"tasks.result.items.metrics.featured_snippet.clickstream_age_distribution.55-64": 1,
"tasks.result.items.metrics.local_pack": {},
"tasks.result.items.metrics.local_pack.pos_1": 1,
"tasks.result.items.metrics.local_pack.pos_2_3": 1,
"tasks.result.items.metrics.local_pack.pos_4_10": 1,
"tasks.result.items.metrics.local_pack.pos_11_20": 1,
"tasks.result.items.metrics.local_pack.pos_21_30": 1,
"tasks.result.items.metrics.local_pack.pos_31_40": 1,
"tasks.result.items.metrics.local_pack.pos_41_50": 1,
"tasks.result.items.metrics.local_pack.pos_51_60": 1,
"tasks.result.items.metrics.local_pack.pos_61_70": 1,
"tasks.result.items.metrics.local_pack.pos_71_80": 1,
"tasks.result.items.metrics.local_pack.pos_81_90": 1,
"tasks.result.items.metrics.local_pack.pos_91_100": 1,
"tasks.result.items.metrics.local_pack.etv": 1,
"tasks.result.items.metrics.local_pack.count": 1,
"tasks.result.items.metrics.local_pack.estimated_paid_traffic_cost": 1,
"tasks.result.items.metrics.local_pack.is_new": 1,
"tasks.result.items.metrics.local_pack.is_up": 1,
"tasks.result.items.metrics.local_pack.is_down": 1,
"tasks.result.items.metrics.local_pack.is_lost": 1,
"tasks.result.items.metrics.local_pack.clickstream_etv": 1,
"tasks.result.items.metrics.local_pack.clickstream_gender_distribution": {},
"tasks.result.items.metrics.local_pack.clickstream_gender_distribution.female": 1,
"tasks.result.items.metrics.local_pack.clickstream_gender_distribution.male": 1,
"tasks.result.items.metrics.local_pack.clickstream_age_distribution": {},
"tasks.result.items.metrics.local_pack.clickstream_age_distribution.18-24": 1,
"tasks.result.items.metrics.local_pack.clickstream_age_distribution.25-34": 1,
"tasks.result.items.metrics.local_pack.clickstream_age_distribution.35-44": 1,
"tasks.result.items.metrics.local_pack.clickstream_age_distribution.45-54": 1,
"tasks.result.items.metrics.local_pack.clickstream_age_distribution.55-64": 1
}