Data API / DataForSEO / Keywords Data
Setting Live ‘Keywords For Site’ Tasks
The Bing keywords a whole site ranks or bids for, from a target 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 Google twin is post_dataforseo_keywords_gads_kw_for_site_live. The submit and fetch twins of this endpoint do the same work asynchronously, at the same price, for batches too large to wait on.
Parameters
No path, query, or header parameters.
Request body
targetstringRequireddomain or URL required field the domain name or URL of the target website
location_namestringOptionalfull name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations example: London,England,United Kingdom
location_codeintegerOptionalsearch engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations example: 2840
location_coordinatestringOptionalGPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter 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
language_namestringOptionalfull name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code supported languages: English, French, German
language_codestringOptionalsearch engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name supported languages: en, fr, de
keywords_negativestring[]Optionalkeywords negative array optional field These keywords will be ignored in the results array; You can specify a maximum of 200 terms that you want to exclude from the results; the specified keywords will be converted to lowercase format
devicestringOptionaldevice type optional field specify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet default value: all
date_fromstringOptionalstarting date of the time range optional field minimal value: 24 months from today’s date; if you don’t specify this field, data will be provided for the last 12 months date format: "yyyy-mm-dd" example: "2020-01-01" Note: we do not recommend using a custom time range for the past year’s dates
date_tostringOptionalending date of the time range optional field if you don’t specify this field, data will be provided for the last 12 months; minimum value: two years back from today’s date; maximum value: one month from today’s date; note: we do not recommend using a custom time range for the past year’s dates; date format: "yyyy-mm-dd" example: "2020-03-15" Note: we do not recommend using a custom time range for the past year’s dates
sort_bystringOptionalresults sorting parameters optional field Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order default value: relevance
search_partnersbooleanOptionalBing search partners type optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search. default value: false – results are returned for Bing, AOL, and Yahoo search networks
tagstringOptionaluser-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/keywords_data/bing/keywords_for_site/live" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"target": "<string>",
"location_name": "<string>",
"location_code": 0,
"location_coordinate": "<string>",
"language_name": "<string>",
"language_code": "<string>",
"keywords_negative": [
"<string>"
],
"device": "<string>"
}'Response
Response fields
versionstringOptionalthe current version of the API
status_codeintegerOptionalgeneral 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_messagestringOptionalgeneral informational message you can find the full list of general informational messages here
timestringOptionalexecution time, seconds
costnumberOptionaltotal tasks cost, USD
tasks_countintegerOptionalthe number of tasks in the tasks array
tasks_errorintegerOptionalthe number of tasks in the tasks array that were returned an error
tasksstring[]Optionalarray of tasks
idstringOptionaltask identifier unique task identifier in our system in the UUID format
status_codeintegerOptionalstatus code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of response codes here
status_messagestringOptionalinformational message of the task you can find the full list of general informational messages here
timestringOptionalexecution time, seconds
costnumberOptionalcost of the task, USD
result_countintegerOptionalnumber of elements in the result array
pathstring[]OptionalURL path
dataobjectOptionalcontains the same parameters that you specified in the POST request
resultstring[]Optionalarray of results
keywordstringOptionalkeyword in a POST array
location_codeintegerOptionallocation code in a POST array
language_codestringOptionallanguage code in a POST array
search_partnersbooleanOptionalindicates whether data from partner networks included in the response
devicestringOptionaldevice type in a POST array if there is no data, then the value is null
competitionnumberOptionalcompetition represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Bing Ads data. Possible values: 0.1, 0.5,0.90.1 – low competition, 0.5 – medium competition, 0.9 – high competition; if there is no data the value is null
cpcnumberOptionalcost-per-click represents the average cost per click (USD) historically paid for the keyword. if there is no data, then the value is null
search_volumeintegerOptionalmonthly average search volume rate represents the (approximate) number of searches for the keyword on the Bing search engine, depending on the user’s targetingsearch volume is rounded to the closest decimal valuesif there is no data, then the value is null
categoriesstring[]Optionalproduct and service categories legacy field, the value will always be null
monthly_searchesstring[]Optionalmonthly searches represents the (approximate) number of searches on this keyword (as available for the past twelve months), targeted to the specified geographic locations. if there is no data, then the value is null
yearintegerOptionalyear
monthintegerOptionalmonth
search_volumeintegerOptionalmonthly average search volume rate search volume is rounded to the closest decimal values