Setting Live ‘Clickstream Global Search Volume’ Tasks
DataForSEO
SEO, search-engine results, keyword research, backlinks and AI visibility 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.
- Тип: array object[]
- keywordsТип: array string[]обязательно
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
- tagТип: string
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
- Тип: object200
Successful response
- Тип: numbercost
total tasks cost, USD
- Тип: integerstatus
_code 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
- Тип: stringstatus
_message general informational message you can find the full list of general informational messages here
- Тип: array string[]tasks
array of tasks
- Тип: integertasks
_count the number of tasks in the tasks array
- Тип: integertasks
_error the number of tasks in the tasks array returned with an error
- Тип: numbertasks
.cost cost of the task, USD
- Тип: objecttasks
.data contains the same parameters that you specified in the POST request
- Тип: stringtasks
.id task identifier unique task identifier in our system in the UUID format
- Тип: array string[]tasks
.path URL path
- Тип: array string[]tasks
.result array of results
- Тип: integertasks
.result _count number of elements in the result array
- Тип: array string[]tasks
.result .items contains keywords and related data
- Тип: integertasks
.result .items _count the number of results returned in the items array
- Тип: array string[]tasks
.result .items .country _distribution distribution of clickstream by countries represents clickstream-based search volume in available countries, as well as its respective percentage of global search volume
- Тип: stringtasks
.result .items .country _distribution .country _iso _code country ISO code
- Тип: numbertasks
.result .items .country _distribution .percentage percentage of global search volume
- Тип: integertasks
.result .items .country _distribution .search _volume search volume in a given country
- Тип: stringtasks
.result .items .keyword keyword keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
- Тип: integertasks
.result .items .search _volume 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
- Тип: integertasks
.status _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
- Тип: stringtasks
.status _message informational message of the task you can find the full list of general informational messages here
- Тип: stringtasks
.time execution time, seconds
- Тип: stringtime
execution time, seconds
- Тип: stringversion
the current version of the API
application/json - 400
Bad request
- 401
Unauthorized
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
Rate limit exceeded
- 500
Internal server error
- 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
The operation failed. Keep the response request ID when contacting Felo support.
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/clickstream_data/global_search_volume/live \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '[
{
"keywords": [
""
],
"tag": ""
}
]'
{
"version": "string",
"status_code": 1,
"status_message": "string",
"time": "string",
"cost": 1,
"tasks_count": 1,
"tasks_error": 1,
"tasks": [
"string"
],
"tasks.id": "string",
"tasks.status_code": 1,
"tasks.status_message": "string",
"tasks.time": "string",
"tasks.cost": 1,
"tasks.result_count": 1,
"tasks.path": [
"string"
],
"tasks.data": {},
"tasks.result": [
"string"
],
"tasks.result.items_count": 1,
"tasks.result.items": [
"string"
],
"tasks.result.items.keyword": "string",
"tasks.result.items.search_volume": 1,
"tasks.result.items.country_distribution": [
"string"
],
"tasks.result.items.country_distribution.country_iso_code": "string",
"tasks.result.items.country_distribution.search_volume": 1,
"tasks.result.items.country_distribution.percentage": 1
}