DataForSEO
SEO, search-engine results, keyword research, backlinks and AI visibility data.
Setting Live ‘Keywords For Site’ Tasks
The Google Ads keywords a whole site ranks or bids for, from a target domain, each with keyword, location_code, language_code, search_partners, competition, competition_index, search_volume, low_top_of_page_bid, high_top_of_page_bid, cpc and monthly_searches. target_type selects the page or the domain. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The submit and fetch twins of this endpoint do the same work asynchronously, at the same price, for batches too large to wait on.
Pricing reference
- Metering: Reported response cost.
- Reference request estimate: USD 0.09.
- Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.
Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.
- Type: array (object | null)[]
- dateType: string | null
_from starting date of the time range
optional field
date format:"yyyy-mm-dd"
minimal value: 4 years from the current date
by default, data is returned for the past 12 months;
Note: the indicated date cannot be greater than that specified indate_toand/or yesterday's date;if Status endpoint returnsfalsein theactual_datafield,date_fromcan be set to the month before last and prior;
if Status endpoint returnstruein theactual_datafield,date_fromcan be set to the last month and prior - dateType: string | null
_to ending date of the time range
optional field
Note: the indicated date cannot be greater than yesterday's date;
if you don't specify this field, yesterday's date will be used by default
date format:"yyyy-mm-dd"
example:"2022-11-30" - includeType: boolean | null
_adult _keywords - languageType: string | null
_code search engine language code
optional field
you can receive the list of available languages of the search engine with theirlanguage_codeby making a separate request tohttps://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:en - languageType: string | null
_name full name of search engine language
optional field
you can receive the list of available languages of the search engine with theirlanguage_nameby making a separate request tohttps://api.dataforseo.com/v3/keywords_data/google_ads/languages
example:English - locationType: integer | null
_code search engine location code
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specifylocation_nameorlocation_coordinate;
you can receive the list of available locations of the search engines with theirlocation_codeby making a separate request tohttps://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:2840 - locationType: string | null
_coordinate GPS coordinates of a location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specifylocation_nameorlocation_code;location_coordinateparameter should be specified in the "latitude,longitude" format;
the data will be provided for the country the specified coordinates belong to;
example:52.6178549,-155.352142 - locationType: string | null
_name full name of search engine location
optional field
if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;
if you use this field, you don't need to specifylocation_codeorlocation_coordinate
you can receive the list of available locations of the search engine with theirlocation_nameby making a separate request tohttps://api.dataforseo.com/v3/keywords_data/google_ads/locations
example:London,England,United Kingdom - searchType: boolean | null
_partners - sortType: string | null
_by results sorting parameters
optional field
Use these parameters to sort the results byrelevance,search_volume,competition_index,low_top_of_page_bid, orhigh_top_of_page_bidin descending order
default value:relevance - tagType: string | null
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 specifiedtagvalue in thedataobject of the response - targetType: string
domain or page
required field
the domain name of the target website or the url of the target page;
note: to obtain keywords for the target website, use thetarget_typeparameter - targetType: string | null
_type search keywords for site or for url
optional field
possible values:site,page;
default value:page;
if set tosite, keywords will be provided for the entire site;
if set topage, keywords will be provided for the specified webpage
- Type: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsKeywordsForSiteLiveResponseInfo200
- Type: number | null Format: doublecost
total tasks cost, USD
- Type: integer | nullstatus
_code general status code you can find the full list of the response codes here
- Type: string | nullstatus
_message general informational message you can find the full list of general informational messages here
- Type: array (object | null)[] | nulltasks
array of tasks
- Type: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsKeywordsForSiteLiveTaskInfo
- costType: number | null Format: double
total tasks cost, USD
- dataType: object | null
contains the same parameters that you specified in the POST request
- propertyType: object | null
Name
- idType: string | null
task identifier unique task identifier in our system in the UUID format
- pathType: array (string | null)[] | null
URL path
- resultType: array (object | null)[] | null
array of results
- competitionType: string | null
- competitionType: integer | null
_index competition index
the competition index for the query indicating how competitive ad placement is for the keyword
can take values from 0 to 100
the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available
if not enough data is available, the value isnull;
learn more about the metric in this help center article - cpcType: number | null
cost per click
indicates the amount paid (USD) for each click on the ad displayed for a given keyword - highType: number | null
_top _of _page _bid maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request - keywordType: string | null
keyword in a POST array
- languageType: string | null
_code language code in a POST array
if there is no data, the value is_nulln - locationType: integer | null
_code location code in a POST array
if there is no data, the value is_nulln - lowType: number | null
_top _of _page _bid minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request - monthlyType: array (object | null)[] | null
_searches monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
if there is no data, the value isnull- monthType: integer | null
month
- searchType: integer | null
_volume monthly average search volume rate
- yearType: integer | null
year
- searchType: boolean | null
_partners include Google search partners
the value you specified when setting the task
iftrue, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
iffalse, the results are returned for Google search sites only - searchType: integer | null Format: int64
_volume monthly average search volume rate
represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting
if there is no data, the value isnull - spellType: string | null
- resultType: integer | null Format: int64
_count number of elements in the result array
- statusType: integer | null
_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
- statusType: string | null
_message informational message of the task you can find the full list of general informational messages here
- timeType: string | null
execution time, seconds
- Type: integer | null Format: int64tasks
_count the number of tasks in the tasks array
- Type: integer | null Format: int64tasks
_error the number of tasks in the tasks array returned with an error
- Type: string | nulltime
total execution time, seconds
- Type: string | nullversion
the current version of the API
application/json - 400
The request could not be processed. Check the request parameters.
- 401
A valid Felo API key is required.
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
A request or spending limit has been reached.
- 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
Error response; upstream passthrough responses may use provider formats
application/json
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/keywords_for_site/live \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '[
{
"location_code": 2840,
"target": "dataforseo.com"
}
]'
{
"version": null,
"status_code": null,
"status_message": null,
"time": null,
"cost": null,
"tasks_count": null,
"tasks_error": null,
"tasks": [
{
"id": null,
"status_code": null,
"status_message": null,
"time": null,
"cost": null,
"result_count": null,
"path": [
null
],
"data": null,
"result": [
{
"keyword": null,
"spell": null,
"location_code": null,
"language_code": null,
"search_partners": null,
"competition": null,
"competition_index": null,
"search_volume": null,
"low_top_of_page_bid": null,
"high_top_of_page_bid": null,
"cpc": null,
"monthly_searches": [
{
"year": null,
"month": null,
"search_volume": null
}
]
}
]
}
]
}