データ API / DataForSEO / Keywords Data

Setting Live ‘DataForSEO Trends Merged Data’ Tasks

Explore, demography and subregion data for the same keywords in one response, rather than three calls. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Prefer it when you want the whole picture: the three siblings each cost a call, and this returns what all three would.

パラメータ

パス・クエリ・ヘッダーのパラメータはありません。

リクエストボディ

keywordsstring[]必須
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
location_namestring任意
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
location_codeinteger任意
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
typestring任意
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
date_fromstring任意
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_tostring任意
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"
time_rangestring任意
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
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/dataforseo_trends/merged_data/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keywords": [
    "<string>"
  ],
  "location_name": "<string>",
  "location_code": 0,
  "type": "<string>",
  "date_from": "<string>",
  "date_to": "<string>",
  "time_range": "<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 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
keywordsstring[]任意
keywords in a POST array
typestring[]任意
search engine type in a POST array
location_codeinteger任意
location code in a POST array if there is no data, then the value is null
language_codestring任意
language code in a POST array if there is no data, then the value is null
datetimestring任意
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
items_countinteger任意
the number of results returned in the items array
itemsstring[]任意
contains keyword popularity and related data
positioninteger任意
the alignment of the element can take the following values: 1, 2, 3, 4, etc.
typestring任意
type of element = ‘demography’
keywordsstring[]任意
relevant keywords the data included in the demography and demography_comparison is based on the keywords listed in this array
datastring[]任意
DataForSEO Trends data for the specified parameters
date_fromstring任意
start date of the corresponding time range in the UTC format: “yyyy-mm-dd”
date_tostring任意
end date of the corresponding time range in the UTC format: “yyyy-mm-dd”
timestampinteger任意
a point in time in the Unix time format
valuesstring[]任意
relative keyword popularity rate at a specific timestamp if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords 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
averagesstring[]任意
keyword popularity values averaged over the whole time range
interestsstring[]任意
subregional keyword popuarity data for each specified term
keywordstring任意
relevant keyword the data included in the values element is based on this keyword
valuesstring[]任意
contains data on relative keyword popularity by country or region
geo_idstring任意
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
geo_namestring任意
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
valueinteger任意
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
interests_comparisonobject任意
comparison of data on subregional keyword popularity for the specified parameters if you specified a single keyword, the value will be null
itemsstring[]任意
keyword popularity values per location values in this array represent percentages relative to the maximum value within each region
geo_idstring任意
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
geo_namestring任意
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
valuesstring[]任意
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
absolute_itemsstring[]任意
keyword popularity rates across all locations values in this array represent percentages relative to the maximum value across all locations
geo_idstring任意
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
geo_namestring任意
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
valuesstring[]任意
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
demographyobject任意
demographic breakdown of keyword popularity data per each specified term conains keyword popularity data by age and gender
agestring[]任意
distribution of keyword popularity by age
keywordstring任意
relevant keyword for which demographic data is provided
valuesstring[]任意
contains age range and corresponding keyword popularity values
typestring任意
age range can take the following values: 18-24, 25-34, 35-44, 45-54, 55-64
valueinteger任意
keyword popularity rate within the specified age range using this value you can understand how popular a keyword is within each age range; calculation: we determine the highest popularity value for the relevant keyword across all age groups, 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 0 means there was not enough data for this term
genderstring[]任意
distribution of keyword popularity by gender
keywordstring任意
relevant keyword for which demographic data is provided
valuesstring[]任意
contains gender and corresponding keyword popularity values
typestring任意
gender category can take the following values: female, male
valueinteger任意
keyword popularity rate within the specified gender category using this value you can understand how popular a keyword is within each gender category; calculation: we determine the highest popularity value for the relevant keyword across all gender categories, 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 0 means there was not enough data for this term
demography_comparisonobject任意
comparison of demographic data on keyword popularity for the specified parameters conains keyword popularity data by age and gender if you specified a single keyword, the value will be null
ageobject任意
comparison of keyword popularity data by age
$18-24string[]任意
indicates age range and contains corresponding keyword popularity values contains comparison of keyword popularity for the specified terms within the specified age range variable can take the following values: 18-24, 18-24, 25-34, 35-44, 45-54, 55-64; using the values from this array, you can understand which of the specified keywords is more popular within the related age range; 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 total popularity value of all keywords within each age range, and then express all other values as a percentage of the total value (100); a value of 100 is the highest popularity for the term a value of 0 means there was not enough data for this term
genderobject任意
comparison of keyword popularity data by gender
femalestring[]任意
indicates gender category and contains corresponding keyword popularity values contains comparison of keyword popularity for the specified terms within the specified gender category; using the values from this array, you can understand which of the specified keywords is more popular within the related gender category; 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 total popularity value of all keywords within each gender category, and then express all other values as a percentage of the total value (100); a value of 100 is the highest popularity for the term a value of 0 means there was not enough data for this term
malestring[]任意
indicates gender category and contains corresponding keyword popularity values contains comparison of keyword popularity for the specified terms within the specified gender category; using the values from this array, you can understand which of the specified keywords is more popular within the related gender category; 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 total popularity value of all keywords within each gender category, and then express all other values as a percentage of the total value (100); a value of 100 is the highest popularity for the term a value of 0 means there was not enough data for this term