Setting Live ‘DataForSEO Trends Subregion Interests’ Tasks
DataForSEO
SEO, search-engine results, keyword research, backlinks and AI visibility data.
Setting Live ‘DataForSEO Trends Subregion Interests’ Tasks
Where interest in a keyword is concentrated, broken down by subregion within location_code. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. For who rather than where, post_dataforseo_keywords_trends_demography_live.
- 類型: array object[]
- keywords類型: array string[]必填
keywords required field the maximum number of keywords you can specify: 5 avoid symbols and special characters (e.g., UTF symbols, emojis); specifying non-Latin characters, you’ll get data for the countries where they are used learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- date類型: string
_from starting date of the time range optional field if you don’t specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other types: 2008-01-01 date format: "yyyy-mm-dd" example: "2019-01-15"
- date類型: string
_to ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15"
- location類型: integer
_code search engine location code optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations note that the data will be provided for the country the specified location_code belongs to; example: 2840
- location類型: string
_name full name of search engine location optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations note that the data will be provided for the country the specified location_name belongs to; example: United Kingdom
- 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
- time類型: string
_range preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years
- type類型: string
dataforseo trends type optional field if you don’t specify this field, the web type will be used by default possible values: web, news, ecommerce
- 類型: 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
- 類型: stringtasks
.result .datetime date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
- 類型: array string[]tasks
.result .items contains keyword popularity and related data
- 類型: integertasks
.result .items _count the number of results returned in the items array
- 類型: array string[]tasks
.result .items .interests subregional keyword popuarity data for each specified term
- 類型: objecttasks
.result .items .interests _comparison comparison of data on subregional keyword popularity for the specified parameters if you specified a single keyword, the value will be null
- 類型: array string[]tasks
.result .items .interests _comparison .absolute _items keyword popularity rates across all locations values in this array represent percentages relative to the maximum value across all locations
- 類型: stringtasks
.result .items .interests _comparison .absolute _items .geo _id location identifier you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations example: US-NY
- 類型: stringtasks
.result .items .interests _comparison .absolute _items .geo _name location name you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations example: Andorra
- 類型: array string[]tasks
.result .items .interests _comparison .absolute _items .values keyword popularity rates relative to all locations represents location-specific keyword popularity rate over the specified time range; using these values, you can understand how popular each keyword is compared to all other keywords across all locations; the first value in the array is provided for the first term from the keywords array, the second value is provided for the second keyword, and so on; calculation: we determine the highest popularity value across all keywords across all locations, and then express all other values as a percentage of that highest value (100); a value of 100 is the peak popularity for the term a value of 50 means that the term is half as popular a value of 0 means there was not enough data for this term
- 類型: array string[]tasks
.result .items .interests _comparison .items keyword popularity values per location values in this array represent percentages relative to the maximum value within each region
- 類型: stringtasks
.result .items .interests _comparison .items .geo _id location identifier you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations example: US-NY
- 類型: stringtasks
.result .items .interests _comparison .items .geo _name location name you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations example: Andorra
- 類型: array string[]tasks
.result .items .interests _comparison .items .values keyword popularity rates within a given location represents location-specific keyword popularity rate over the specified time range; using these values, you can understand which of the specified keywords is more popular in the related location; the first value in the array is provided for the first term from the keywords array, the second value is provided for the second keyword, and so on; calculation: we determine the highest popularity value across all specified keywords within a given location, and then express the popularity values of each keyword as a percentage of the highest value (100); a value of 100 is the peak popularity for the term a value of 50 means that the term is half as popular a value of 0 means there was not enough data for this term
- 類型: stringtasks
.result .items .interests .keyword relevant keyword the data included in the values element is based on this keyword
- 類型: array string[]tasks
.result .items .interests .values contains data on relative keyword popularity by country or region
- 類型: stringtasks
.result .items .interests .values .geo _id location identifier you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their geo_id here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations example: US-NY
- 類型: stringtasks
.result .items .interests .values .geo _name location name you can use this field for matching obtained results with location parameters specified in the request see the full list of available locations with their geo_name here or by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations example: Andorra
- 類型: integertasks
.result .items .interests .values .value relative keyword popularity rate in a given location represents location-specific keyword popularity rate over the specified time range; using this value you can understand how popular a keyword is in one location compared to another location; calculation: we determine the highest popularity value for the relevant keyword across all locations, and then express all other values as a percentage of that highest value (100); a value of 100 is the highest popularity for the term a value of 50 means that the term is half as popular a value of 0 means there was not enough data for this term
- 類型: array string[]tasks
.result .items .keywords relevant keywords the data included in the interests and interests_comparison is based on the keywords listed in this array
- 類型: integertasks
.result .items .position the alignment of the element can take the following values: 1, 2, 3, 4, etc.
- 類型: stringtasks
.result .items .type type of element = ‘subregion_interests’
- 類型: array string[]tasks
.result .keywords keywords in a POST array
- 類型: stringtasks
.result .language _code language code in a POST array if there is no data, then the value is null
- 類型: integertasks
.result .location _code location code in a POST array if there is no data, then the value is null
- 類型: array string[]tasks
.result .type search engine type in a POST array
- 類型: 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 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/dataforseo_trends/subregion_interests/live \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '[
{
"keywords": [
""
],
"location_name": "",
"location_code": 1,
"type": "",
"date_from": "",
"date_to": "",
"time_range": "",
"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.keywords": [
"string"
],
"tasks.result.type": [
"string"
],
"tasks.result.location_code": 1,
"tasks.result.language_code": "string",
"tasks.result.datetime": "string",
"tasks.result.items_count": 1,
"tasks.result.items": [
"string"
],
"tasks.result.items.position": 1,
"tasks.result.items.type": "string",
"tasks.result.items.keywords": [
"string"
],
"tasks.result.items.interests": [
"string"
],
"tasks.result.items.interests.keyword": "string",
"tasks.result.items.interests.values": [
"string"
],
"tasks.result.items.interests.values.geo_id": "string",
"tasks.result.items.interests.values.geo_name": "string",
"tasks.result.items.interests.values.value": 1,
"tasks.result.items.interests_comparison": {},
"tasks.result.items.interests_comparison.items": [
"string"
],
"tasks.result.items.interests_comparison.items.geo_id": "string",
"tasks.result.items.interests_comparison.items.geo_name": "string",
"tasks.result.items.interests_comparison.items.values": [
"string"
],
"tasks.result.items.interests_comparison.absolute_items": [
"string"
],
"tasks.result.items.interests_comparison.absolute_items.geo_id": "string",
"tasks.result.items.interests_comparison.absolute_items.geo_name": "string",
"tasks.result.items.interests_comparison.absolute_items.values": [
"string"
]
}