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.
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)[]
- keywordsType: 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 articlelearn more about rules and limitations of
keywordandkeywordsfields in DataForSEO APIs in this Help Center article - 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
- Type: object | null · Response36Afe1097B20_KeywordsDataClickstreamDataGlobalSearchVolumeLiveResponseInfo200
- 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_KeywordsDataClickstreamDataGlobalSearchVolumeLiveTaskInfo
- 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: array (object | null)[] | null
array of results
- itemsType: array (object | null)[] | null
contains keywords and related data
- countryType: array (object | null)[] | null
_distribution distribution of clickstream by countries
represents clickstream-based search volume in available countries, as well as its respective percentage of global search volume- countryType: string | null
_iso _code country ISO code
- percentageType: number | null
percentage of global search volume
- searchType: integer | null Format: int64
_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
- keywordType: string | null
keyword
keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character) - searchType: integer | null Format: int64
_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
- itemsType: integer | null Format: int64
_count the number of results returned in the
itemsarray
- 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/clickstream_data/global_search_volume/live \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '[
{
"tag": "test-tag",
"keywords": [
"you tube",
"youtube",
"youtub"
]
}
]'
{
"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": [
{
"items_count": null,
"items": [
{
"keyword": null,
"search_volume": null,
"country_distribution": [
"[Max Depth Exceeded]"
]
}
]
}
]
}
]
}