Data API / DataForSEO / DataForSEO Labs

Keyword Ideas

Expands seed keywords into ideas that share their semantic space. Returns seed_keywords, total_count, items_count, offset, offset_token and items. Pages with limit, offset and offset_token; use the token past the first pages. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Prefer this one. For variants of one phrase rather than the wider space, post_dataforseo_labs_google_keyword_suggestions_live.

Параметры

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

Тело запроса

keywordsstring[]Необязательный
keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. 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/dataforseo_labs/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/dataforseo_labs/locations_and_languages example: 2840
language_namestringНеобязательный
full name of the language optional field 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/dataforseo_labs/locations_and_languages example: English Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language
language_codestringНеобязательный
language code optional field 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/dataforseo_labs/locations_and_languages example: en Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language
closely_variantsbooleanНеобязательный
search mode optional field if set to true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: false
ignore_synonymsbooleanНеобязательный
ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false
include_serp_infobooleanНеобязательный
include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false
include_clickstream_databooleanНеобязательный
include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article
limitintegerНеобязательный
the maximum number of keywords in the results array optional field default value: 700 maximum value: 1000
offsetintegerНеобязательный
offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.
offset_tokenstringНеобязательный
offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center
filtersarrayНеобязательный
array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , , >, >=, =, , in, not_in, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters note that you can not filter the results by relevance example: ["keyword_info.search_volume",">",0] [["keyword_info.search_volume","in",[0,1000]], "and", ["keyword_info.competition_level","=","LOW"]] [["keyword_info.search_volume",">",100], "and", [["keyword_info.cpc"," for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
order_bystring[]Необязательный
results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter default rule: ["relevance,desc"] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint. note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["relevance,desc","keyword_info.search_volume,desc"]
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/dataforseo_labs/google/keyword_ideas/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>",
  "closely_variants": false,
  "ignore_synonyms": false,
  "include_serp_info": false
}'

Ответ

Поля ответа

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
se_typestringНеобязательный
search engine type
seed_keywordsstring[]Необязательный
keywords in a POST array keywords are returned with decoded %## (plus character ‘+’ will be decoded to a space character)
location_codeintegerНеобязательный
location code in a POST array
language_codestringНеобязательный
language code in a POST array
total_countintegerНеобязательный
total number of results relevant to your request in our database
items_countintegerНеобязательный
number of results returned in the items array
offsetintegerНеобязательный
current offset value
offset_tokenstringНеобязательный
offset token for subsequent requests you can use the string provided in this field to get the subsequent results of the initial task; note: offset_token values are unique for each subsequent task
itemsstring[]Необязательный
contains keyword ideas and related data
se_typestringНеобязательный
search engine type
keywordstringНеобязательный
returned keyword idea
location_codeintegerНеобязательный
location code in a POST array
language_codestringНеобязательный
language code in a POST array
keyword_infoobjectНеобязательный
keyword data for the returned keyword idea
se_typestringНеобязательный
search engine type
last_updated_timestringНеобязательный
date and time when keyword data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
competitionnumberНеобязательный
competition represents the relative amount of competition associated with the given keyword; the value is based on Google Ads data and can be between 0 and 1 (inclusive)
competition_levelstringНеобязательный
competition level represents the relative level of competition associated with the given keyword in paid SERP only; possible values: LOW, MEDIUM, HIGH if competition level is unknown, the value is null; learn more about the metric in this help center article
cpcnumberНеобязательный
cost-per-click represents the average cost per click (USD) historically paid for the keyword
search_volumeintegerНеобязательный
average monthly search volume rate represents the (approximate) number of searches for the given keyword idea on google.com
low_top_of_page_bidnumberНеобязательный
minimum bid for the ad to be displayed at the top of the first page indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request
high_top_of_page_bidnumberНеобязательный
maximum bid for the ad to be displayed at the top of the first page indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request
categoriesstring[]Необязательный
product and service categories you can download the full list of possible categories
monthly_searchesstring[]Необязательный
monthly searches represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
yearintegerНеобязательный
year
monthintegerНеобязательный
month
search_volumeintegerНеобязательный
monthly average search volume rate
search_volume_trendobjectНеобязательный
search volume trend changes represents search volume change in percent compared to the previous period
monthlyintegerНеобязательный
search volume change in percent compared to the previous month
quarterlyintegerНеобязательный
search volume change in percent compared to the previous quarter
yearlyintegerНеобязательный
search volume change in percent compared to the previous year
clickstream_keyword_infoobjectНеобязательный
clickstream data for the returned keyword to retrieve results for this field, the parameter include_clickstream_data must be set to true
search_volumeintegerНеобязательный
monthly average clickstream search volume rate
last_updated_timestringНеобязательный
date and time when the clickstream dataset was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
gender_distributionobjectНеобязательный
distribution of estimated clickstream-based metrics by gender learn more about how the metric is calculated in this help center article
femaleintegerНеобязательный
number of female users in the relevant clickstream dataset
maleintegerНеобязательный
number of male users in the relevant clickstream dataset
age_distributionobjectНеобязательный
distribution of clickstream-based metrics by age learn more about how the metric is calculated in this help center article
18-24integerНеобязательный
number of users in the relevant clickstream dataset that fall within the 18-24 age range
25-34integerНеобязательный
number of users in the relevant clickstream dataset that fall within the 25-34 age range
35-44integerНеобязательный
number of users in the relevant clickstream dataset that fall within the 35-44 age range
45-54integerНеобязательный
number of users in the relevant clickstream dataset that fall within the 45-54 age range
55-64integerНеобязательный
number of users in the relevant clickstream dataset that fall within the 55-64 age range
monthly_searchesstring[]Необязательный
monthly clickstream search volume rates array of objects with clickstream search volume rates in a certain month of a year
yearintegerНеобязательный
year
monthintegerНеобязательный
month
search_volumeintegerНеобязательный
clickstream-based search volume rate in a certain month of a year
keyword_propertiesobjectНеобязательный
additional information about the keyword
se_typestringНеобязательный
search engine type
core_keywordstringНеобязательный
main keyword in a group contains the main keyword in a group determined by the synonym clustering algorithm if the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword
synonym_clustering_algorithmstringНеобязательный
the algorithm used to identify synonyms possible values: keyword_metrics – indicates the algorithm based on keyword_info parameters text_processing – indicates the text-based algorithm if the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword
keyword_difficultyintegerНеобязательный
difficulty of ranking in the first top-10 organic results for a keyword indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100; calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP; learn more about the metric in this help center guide
detected_languagestringНеобязательный
detected language of the keyword indicates the language of the keyword as identified by our system
is_another_languagebooleanНеобязательный
detected language of the keyword is different from the set language if true, the language set in the request does not match the language determined by our system for a given keyword
words_countintegerНеобязательный
number of words in the keyword indicates how many words the keyword consists of
serp_infoobjectНеобязательный
SERP data the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database
se_typestringНеобязательный
search engine type
check_urlstringНеобязательный
direct URL to search engine results you can use it to make sure that we provided accurate results
serp_item_typesstring[]Необязательный
types of search results in SERP contains types of search results (items) found in SERP possible item types: answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites, courses, ai_overview; note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements
se_results_countstringНеобязательный
number of search results for the returned keyword
last_updated_timestringНеобязательный
date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
previous_updated_timestringНеобязательный
previous to the most recent date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-10-15 12:57:46 +00:00
avg_backlinks_infoobjectНеобязательный
backlink data for the returned keyword this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 webpages ranking organically for the keyword
se_typestringНеобязательный
search engine type
backlinksnumberНеобязательный
average number of backlinks
dofollownumberНеобязательный
average number of dofollow links
referring_pagesnumberНеобязательный
average number of referring pages
referring_domainsnumberНеобязательный
average number of referring domains
referring_main_domainsnumberНеобязательный
average number of referring main domains
ranknumberНеобязательный
average rank learn more about the metric and its calculation formula in this help center article
main_domain_ranknumberНеобязательный
average main domain rank learn more about the metric and its calculation formula in this help center article
last_updated_timestringНеобязательный
date and time when backlink data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
search_intent_infoobjectНеобязательный
search intent info for the returned keyword learn about search intent in this help center article
se_typestringНеобязательный
search engine type possible values: google
main_intentstringНеобязательный
main search intent possible values: informational, navigational, commercial, transactional
foreign_intentstring[]Необязательный
supplementary search intents possible values: informational, navigational, commercial, transactional
last_updated_timestringНеобязательный
date and time when search intent data was last updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
keyword_info_normalized_with_bingobjectНеобязательный
contains keyword search volume normalized with Bing search volume
last_updated_timestringНеобязательный
date and time when the dataset was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
search_volumeintegerНеобязательный
current search volume rate of a keyword
is_normalizedbooleanНеобязательный
keyword info is normalized if true, values are normalized with Bing data
monthly_searchesintegerНеобязательный
monthly search volume rates array of objects with search volume rates in a certain month of a year
yearintegerНеобязательный
year
monthintegerНеобязательный
month
search_volumeintegerНеобязательный
search volume rate in a certain month of a year
keyword_info_normalized_with_clickstreamobjectНеобязательный
contains keyword search volume normalized with clickstream data
last_updated_timestringНеобязательный
date and time when the dataset was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
search_volumeintegerНеобязательный
current search volume rate of a keyword
is_normalizedbooleanНеобязательный
keyword info is normalized if true, values are normalized with clickstream data
monthly_searchesintegerНеобязательный
monthly search volume rates array of objects with search volume rates in a certain month of a year
yearintegerНеобязательный
year
monthintegerНеобязательный
month
search_volumeintegerНеобязательный
search volume rate in a certain month of a year