Data API / DataForSEO / AI Optimization
AI Keyword Data Keyword Search Volume
Returns location_code, language_code, items_count and items. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. For classical search volume use post_dataforseo_keywords_gads_search_volume_live; the two answer different questions and often disagree.
Параметры
Параметров пути, запроса и заголовков нет.
Тело запроса
keywordsstring[]Обязательныйkeywords required field UTF-8 encoding The maximum number of keywords you can specify: 1000; The maximum number of characters in a single keyword: 250; The keywords will be converted to lowercase format;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
location_namestringНеобязательныйfull name of the location required field if you don't specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages example: United Kingdom
location_codeintegerНеобязательныйunique location identifier required field if you don't specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages example: 2840
language_namestringНеобязательныйfull name of the language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages example: English
language_codestringНеобязательныйlanguage code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages example: en
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/ai_optimization/ai_keyword_data/keywords_search_volume/live" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keywords": [
"<string>"
],
"location_name": "<string>",
"location_code": 0,
"language_name": "<string>",
"language_code": "<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 the 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
location_codeintegerНеобязательныйlocation code in a POST array
language_codestringНеобязательныйlanguage code in a POST array
items_countintegerНеобязательныйnumber of results returned in the items array
itemsstring[]Необязательныйcontains specified keywords with their AI search volume rates
keywordstringНеобязательныйspecified keyword
ai_search_volumeintegerНеобязательныйcurrent AI search volume rate of a keyword learn more about this metric here
ai_monthly_searchesstring[]Необязательныйmonthly AI search volume rates array of objects with AI search volume rates in a certain month of a year
yearintegerНеобязательныйyear
monthintegerНеобязательныйmonth
ai_search_volumeintegerНеобязательныйAI search volume rate in a certain month of a year learn more about this metric here