データ API / DataForSEO / DataForSEO Labs

Keyword Suggestions

Long-tail variants containing one keyword - the phrase-match view, where post_dataforseo_labs_google_keyword_ideas_live is the semantic one. Returns seed_keyword, seed_keyword_data, total_count, 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.

パラメータ

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

リクエストボディ

keywordstring任意
keyword required field UTF-8 encoding 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 optional field if you use this field, you don’t need to specify 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 ignore this field to get the results for all available locations example: United Kingdom
location_codeinteger任意
location code optional field if you use this field, you don’t need to specify location_name 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 ignore this field to get the results for all available locations 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
include_seed_keywordboolean任意
include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response 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
exact_matchboolean任意
search for the exact phrase optional field if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase 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
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 and not_ilike to match any string of zero or more characters 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 a comma is used as a separator example: ["keyword_info.competition,desc"] default rule: ["keyword_info.search_volume,desc"] 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: ["keyword_info.search_volume,desc","keyword_info.cpc,desc"]
limitinteger任意
the maximum number of returned keywords optional field default value: 100 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
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_suggestions/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "include_seed_keyword": false,
  "include_serp_info": false,
  "include_clickstream_data": 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_keywordstring任意
keyword in a POST array
seed_keyword_dataobject任意
keyword data for the seed keyword fields in this object are identical to those of the items 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
total_countinteger任意
total amount of results in our database relevant to your request
items_countinteger任意
the 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 keywords and related data
se_typestring任意
search engine type
keywordstring任意
keyword suggestion
location_codeinteger任意
location code in a POST array
language_codestring任意
language code in a POST array
keyword_infoobject任意
keyword data for the returned keyword
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 for 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