Setting ‘Keyword Suggestions For URL’ Tasks
This endpoint provides keyword suggestions based on the content of a given webpage URL. It analyzes the page and returns a list of relevant keywords, along with a confidence score that indicates the probability that the keyword would match a user’s search query.
This is the Standard method of data retrieval. If you don’t need to receive data in real-time, this method is the best option for you. Set a task and retrieve the results when our system collects them. Execution time depends on the system workload.
If your system requires delivering instant results, the Live method will be a better solution. This method doesn’t require making separate POST and GET requests to the corresponding endpoints.
All POST data should be sent in the JSON format (UTF-8 encoding). Task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute, with each POST call containing no more than 100 tasks. If your POST call contains over 100 tasks, the tasks over this limit will return the 40006 error. Visit DataForSEO Help Center to get practical tips for request handling depending on your Keyword Data API payload volume.
You can also retrieve the results of completed tasks using the unique task identifier id. Alternatively, we can send them to you as soon as they are ready if you specify the postback_url or pingback_url when setting a task. Note that if your server doesn’t respond within 10 seconds, the connection will be aborted by timeout, and the task will be transferred to the tasks_ready list. The error code and message depend on your server’s configuration.
See Help Center to learn more about using pingbacks and postbacks with DataForSEO APIs.
Below you will find a detailed description of the fields you can use for setting a task.
Description of the fields for setting a task:
| Field name |
Type |
Description |
target |
string |
target URL of the webpage to scan for possible keywords
required field
maximum length: 2000 characters |
language_name |
string |
full 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
you can receive the list of available languages with their language_name by making a separate request to the
https://api.dataforseo.com/v3/keywords_data/bing/keyword_suggestions_for_url/languages
example:
English
|
language_code |
string |
search 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
you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_suggestions_for_url/languages
example:
en
|
exclude_brands |
boolean |
determines whether the results exclude brand keywords
optional field
|
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
Description of the fields in the results array:
| Field name |
Type |
Description |
version |
string |
the current version of the API |
status_code |
integer |
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_message |
string |
general informational message
you can find the full list of general informational messages here |
status_message |
string |
general informational message |
time |
string |
execution time, seconds |
cost |
float |
total tasks cost, USD |
tasks_count |
integer |
the number of tasks in the tasks array |
tasks_error |
integer |
the number of tasks in the tasks array returned with an error |
tasks |
array |
array of tasks |
id |
string |
task identifier
unique task identifier in our system in the UUID format |
status_code |
integer |
status 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_message |
string |
informational message of the task
you can find the full list of general informational messages here |
time |
string |
execution time, seconds |
cost |
float |
cost of the task, USD |
result_count |
integer |
number of elements in the result array |
path |
array |
URL path |
data |
object |
contains the same parameters that you specified in the POST request |
result |
array |
array of results
in this case, the value will be null |