DataForSEO
SEO, search-engine results, keyword research, backlinks and AI visibility data.
Setting ‘Keywords For Site’ Tasks
Queues a Bing keywords-for-site task, returning a task id. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Retrieve with get_dataforseo_keywords_bing_kw_for_site_fetch.
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
minimal value: 24 months from today's date;
if you don't specify this field, data will be provided for the last 12 months;
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;
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
- dateType: string | null
_to ending 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;
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
- deviceType: string | null
device type
optional field
specify this field if you want to get the data for a particular device type
possible values:all,mobile,desktop,tablet
default value:all - keywordsType: array string[] | null
_negative keywords 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 - languageType: string
_code search engine language code
required field if you don't specifylanguage_name
if you use this field, you don't need to specifylanguage_name
supported languages:en,fr,de - languageType: string
_name full name of search engine language
required field if you don't specifylanguage_code
if you use this field, you don't need to specifylanguage_code
supported languages:English,French,German - locationType: integer
_code search engine location code
required field if you don't specifylocation_nameorlocation_coordinate
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/bing/locations
example:2840 - locationType: string
_coordinate GPS coordinates of a location
required field if you don't specifylocation_nameorlocation_code
if you use this field, you don't need to specifylocation_nameorlocation_codelocation_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
_name full name of search engine location
required field if you don't specifylocation_codeorlocation_coordinate
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/bing/locations
example:London,England,United Kingdom - pingbackType: string | null
_url notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a$idvariable and ‘$tag’ as urlencoded$tagvariable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters inpingback_urlwill be urlencoded;
i.a., the#character will be encoded into%23 - postbackType: string | null
_url URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in thegzipformat to thepostback_urlyou specified
you can use the ‘$id’ string as a$idvariable and ‘$tag’ as urlencoded$tagvariable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters inpostback_urlwill be urlencoded;
i.a., the#character will be encoded into%23 - searchType: boolean | null
_partners Bing search partners type
optional field
if you specifytrue, 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 - sortType: string | null
_by results sorting parameters
optional field
Use these parameters to sort the results bysearch_volume,cpc,competitionorrelevancein the 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 URL
required field
the URL of the webpage or the domain to scan for possible keywords
- Type: object | null · Response36Afe1097B20_KeywordsDataBingKeywordsForSiteTaskPostResponseInfo200
- 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_KeywordsDataBingKeywordsForSiteTaskPostTaskInfo
- 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: object | null
array of results
in this case, the value will benull - 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/bing/keywords_for_site/task_post \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '[
{
"language_code": "en",
"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": null
}
]
}