Data API / DataForSEO / Keywords Data

Setting Live ‘Clickstream Global Search Volume’ Tasks

Clickstream search volume for keywords worldwide, with no location argument at all - the global total and its per-country breakdown. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Use it to decide which markets are worth a per-location call; the located variant is post_dataforseo_keywords_clickstream_search_volume_live.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

keywordsstring[]Обязательный
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
tagstringНеобязательный
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

Пример запроса

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

Ответ

Поля ответа

versionstringНеобязательный
the current version of the API
status_codeintegerНеобязательный
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_messagestringНеобязательный
general informational message you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
total tasks cost, USD
tasks_countintegerНеобязательный
the number of tasks in the tasks array
tasks_errorintegerНеобязательный
the number of tasks in the tasks array returned with an error
tasksstring[]Необязательный
array of tasks
idstringНеобязательный
task identifier unique task identifier in our system in the UUID format
status_codeintegerНеобязательный
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_messagestringНеобязательный
informational message of the task you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
cost of the task, USD
result_countintegerНеобязательный
number of elements in the result array
pathstring[]Необязательный
URL path
dataobjectНеобязательный
contains the same parameters that you specified in the POST request
resultstring[]Необязательный
array of results
items_countintegerНеобязательный
the number of results returned in the items array
itemsstring[]Необязательный
contains keywords and related data
keywordstringНеобязательный
keyword keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
search_volumeintegerНеобязательный
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
country_distributionstring[]Необязательный
distribution of clickstream by countries represents clickstream-based search volume in available countries, as well as its respective percentage of global search volume
country_iso_codestringНеобязательный
country ISO code
search_volumeintegerНеобязательный
search volume in a given country
percentagenumberНеобязательный
percentage of global search volume