Data API / DataForSEO / Keywords Data

Setting Live ‘Bulk Clickstream Search Volume’ Tasks

Clickstream search volume for many keywords in one call, without the language dimension. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The per-keyword-with-language variant is post_dataforseo_keywords_clickstream_search_volume_live. Since the price is per call and not per keyword, this is the one to use for a list.

Parameters

No path, query, or header parameters.

Request body

keywordsstring[]Required
target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; each keyword should be at least 3 characters long; the keywords will be converted to lowercase format; Note: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed to learn more about which symbols and characters can be used, please refer to this article learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
location_namestringOptional
full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or 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/keywords_data/clickstream_data/locations_and_languages example: United Kingdom
location_codeintegerOptional
location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages example: 2840
tagstringOptional
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

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/clickstream_data/bulk_search_volume/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keywords": [
    "<string>"
  ],
  "location_name": "<string>",
  "location_code": 0,
  "tag": "<string>"
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
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_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array returned with an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
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
status_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
location_codeintegerOptional
location code in a POST array
items_countintegerOptional
the number of results returned in the items array
itemsstring[]Optional
contains keywords and related data
keywordstringOptional
keyword keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)
search_volumeintegerOptional
clickstream-based average monthly search volume rate represents the (approximate) number of searches for the given keyword idea based on clickstream you can learn more about clickstream search volume in this Help Center article
monthly_searchesstring[]Optional
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
yearintegerOptional
year
monthintegerOptional
month
search_volumeintegerOptional
monthly average search volume rate