Data API / DataForSEO / Keywords Data

Setting Live ‘DataForSEO Trends Demography’ Tasks

The Google Trends audience behind a keyword: age and gender splits over the same window post_dataforseo_keywords_trends_explore_live uses, with the same type and date arguments. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Cheap like its sibling. For where rather than who, use post_dataforseo_keywords_trends_subregion_interests_live.

Параметры

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

Тело запроса

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/demography/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
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, 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