Skip to main content
POST
https://api.aisa.one/apis/v1
/
dataforseo
/
dataforseo_labs
/
google
/
keyword_overview
/
live
Keyword Overview
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/keyword_overview/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keywords": [
    "<string>"
  ],
  "location_name": "<string>",
  "location_code": 123,
  "language_name": "<string>",
  "language_code": "<string>",
  "include_serp_info": true,
  "include_clickstream_data": true,
  "tag": "<string>"
}
'
{
  "version": "<string>",
  "status_code": 123,
  "status_message": "<string>",
  "time": "<string>",
  "cost": 123,
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    "<string>"
  ],
  "tasks.id": "<string>",
  "tasks.status_code": 123,
  "tasks.status_message": "<string>",
  "tasks.time": "<string>",
  "tasks.cost": 123,
  "tasks.result_count": 123,
  "tasks.path": [
    "<string>"
  ],
  "tasks.data": {},
  "tasks.result": [
    "<string>"
  ],
  "tasks.result.se_type": "<string>",
  "tasks.result.location_code": 123,
  "tasks.result.language_code": "<string>",
  "tasks.result.items_count": 123,
  "tasks.result.items": [
    "<string>"
  ],
  "tasks.result.items.se_type": "<string>",
  "tasks.result.items.keyword": "<string>",
  "tasks.result.items.location_code": 123,
  "tasks.result.items.language_code": "<string>",
  "tasks.result.items.search_partners": true,
  "tasks.result.items.keyword_info": {},
  "tasks.result.items.keyword_info.se_type": "<string>",
  "tasks.result.items.keyword_info.last_updated_time": "<string>",
  "tasks.result.items.keyword_info.competition": 123,
  "tasks.result.items.keyword_info.competition_level": "<string>",
  "tasks.result.items.keyword_info.cpc": 123,
  "tasks.result.items.keyword_info.search_volume": 123,
  "tasks.result.items.keyword_info.low_top_of_page_bid": 123,
  "tasks.result.items.keyword_info.high_top_of_page_bid": 123,
  "tasks.result.items.keyword_info.categories": [
    "<string>"
  ],
  "tasks.result.items.keyword_info.monthly_searches": [
    "<string>"
  ],
  "tasks.result.items.keyword_info.monthly_searches.year": 123,
  "tasks.result.items.keyword_info.monthly_searches.month": 123,
  "tasks.result.items.keyword_info.monthly_searches.search_volume": 123,
  "tasks.result.items.keyword_info.search_volume_trend": {},
  "tasks.result.items.keyword_info.search_volume_trend.monthly": 123,
  "tasks.result.items.keyword_info.search_volume_trend.quarterly": 123,
  "tasks.result.items.keyword_info.search_volume_trend.yearly": 123,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_bing": {},
  "tasks.result.items.keyword_info.keyword_info_normalized_with_bing.last_updated_time": "<string>",
  "tasks.result.items.keyword_info.keyword_info_normalized_with_bing.search_volume": 123,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_bing.is_normalized": true,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_bing.monthly_searches": 123,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_bing.monthly_searches.year": 123,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_bing.monthly_searches.month": 123,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_bing.monthly_searches.search_volume": 123,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream": {},
  "tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.last_updated_time": "<string>",
  "tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.search_volume": 123,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.is_normalized": true,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.monthly_searches": 123,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.monthly_searches.year": 123,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.monthly_searches.month": 123,
  "tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.monthly_searches.search_volume": 123,
  "tasks.result.items.clickstream_keyword_info": {},
  "tasks.result.items.clickstream_keyword_info.search_volume": 123,
  "tasks.result.items.clickstream_keyword_info.last_updated_time": "<string>",
  "tasks.result.items.clickstream_keyword_info.gender_distribution": {},
  "tasks.result.items.clickstream_keyword_info.gender_distribution.female": 123,
  "tasks.result.items.clickstream_keyword_info.gender_distribution.male": 123,
  "tasks.result.items.clickstream_keyword_info.age_distribution": {},
  "tasks.result.items.clickstream_keyword_info.age_distribution.18-24": 123,
  "tasks.result.items.clickstream_keyword_info.age_distribution.25-34": 123,
  "tasks.result.items.clickstream_keyword_info.age_distribution.35-44": 123,
  "tasks.result.items.clickstream_keyword_info.age_distribution.45-54": 123,
  "tasks.result.items.clickstream_keyword_info.age_distribution.55-64": 123,
  "tasks.result.items.clickstream_keyword_info.monthly_searches": [
    "<string>"
  ],
  "tasks.result.items.clickstream_keyword_info.monthly_searches.year": 123,
  "tasks.result.items.clickstream_keyword_info.monthly_searches.month": 123,
  "tasks.result.items.clickstream_keyword_info.monthly_searches.search_volume": 123,
  "tasks.result.items.keyword_properties": {},
  "tasks.result.items.keyword_properties.se_type": "<string>",
  "tasks.result.items.keyword_properties.core_keyword": "<string>",
  "tasks.result.items.keyword_properties.synonym_clustering_algorithm": "<string>",
  "tasks.result.items.keyword_properties.keyword_difficulty": 123,
  "tasks.result.items.keyword_properties.detected_language": "<string>",
  "tasks.result.items.keyword_properties.is_another_language": true,
  "tasks.result.items.serp_info": {},
  "tasks.result.items.serp_info.se_type": "<string>",
  "tasks.result.items.serp_info.check_url": "<string>",
  "tasks.result.items.serp_info.serp_item_types": [
    "<string>"
  ],
  "tasks.result.items.serp_info.se_results_count": "<string>",
  "tasks.result.items.serp_info.last_updated_time": "<string>",
  "tasks.result.items.serp_info.previous_updated_time": "<string>",
  "tasks.result.items.avg_backlinks_info": {},
  "tasks.result.items.avg_backlinks_info.se_type": "<string>",
  "tasks.result.items.avg_backlinks_info.backlinks": 123,
  "tasks.result.items.avg_backlinks_info.dofollow": 123,
  "tasks.result.items.avg_backlinks_info.referring_pages": 123,
  "tasks.result.items.avg_backlinks_info.referring_domains": 123,
  "tasks.result.items.avg_backlinks_info.referring_main_domains": 123,
  "tasks.result.items.avg_backlinks_info.rank": 123,
  "tasks.result.items.avg_backlinks_info.main_domain_rank": 123,
  "tasks.result.items.avg_backlinks_info.last_updated_time": "<string>",
  "tasks.result.items.search_intent_info": {},
  "tasks.result.items.search_intent_info.se_type": "<string>",
  "tasks.result.items.search_intent_info.main_intent": "<string>",
  "tasks.result.items.search_intent_info.foreign_intent": [
    "<string>"
  ],
  "tasks.result.items.search_intent_info.last_updated_time": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://aisa.one/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
keywords
string[]
required

keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article

​
location_name
string
required

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_code
integer
required

location code 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_name
string
required

full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English

​
language_code
string
required

language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en

​
include_serp_info
boolean

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_data
boolean

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

​
tag
string

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

Response

Successful response

​
version
string

the current version of the API

​
status_code
integer

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_message
string

general informational message you can find the full list of general informational messages here

​
time
string

execution time, seconds

​
cost
number

total tasks cost, USD

​
tasks_count
integer

the number of tasks in the tasks array

​
tasks_error
integer

the number of tasks in the tasks array returned with an error

​
tasks
string[]

array of tasks

​
tasks.id
string

task identifier unique task identifier in our system in the UUID format

​
tasks.status_code
integer

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

​
tasks.status_message
string

informational message of the task you can find the full list of general informational messages here

​
tasks.time
string

execution time, seconds

​
tasks.cost
number

cost of the task, USD

​
tasks.result_count
integer

number of elements in the result array

​
tasks.path
string[]

URL path

​
tasks.data
object

contains the same parameters that you specified in the POST request

​
tasks.result
string[]

array of results

​
tasks.result.se_type
string

search engine type

​
tasks.result.location_code
integer

location code in a POST array

​
tasks.result.language_code
string

language code in a POST array

​
tasks.result.items_count
integer

the number of results returned in the items array

​
tasks.result.items
string[]

contains keywords and related data

​
tasks.result.items.se_type
string

search engine type

​
tasks.result.items.keyword
string

keyword keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)

​
tasks.result.items.location_code
integer

location code in a POST array if there is no data, then the value is null

​
tasks.result.items.language_code
string

language code in a POST array

​
tasks.result.items.search_partners
boolean

indicates data for Google and partner sites if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search; if false, the results are returned for Google search sites only

​
tasks.result.items.keyword_info
object

keyword data for the returned keyword

​
tasks.result.items.keyword_info.se_type
string

search engine type

​
tasks.result.items.keyword_info.last_updated_time
string

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

​
tasks.result.items.keyword_info.competition
number

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)

​
tasks.result.items.keyword_info.competition_level
string

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

​
tasks.result.items.keyword_info.cpc
number

cost-per-click represents the average cost per click (USD) historically paid for the keyword

​
tasks.result.items.keyword_info.search_volume
integer

average monthly search volume rate represents the (approximate) number of searches for the given keyword idea on google.com

​
tasks.result.items.keyword_info.low_top_of_page_bid
number

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

​
tasks.result.items.keyword_info.high_top_of_page_bid
number

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

​
tasks.result.items.keyword_info.categories
string[]

product and service categories you can download the full list of possible categories

​
tasks.result.items.keyword_info.monthly_searches
string[]

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

​
tasks.result.items.keyword_info.monthly_searches.year
integer

year

​
tasks.result.items.keyword_info.monthly_searches.month
integer

month

​
tasks.result.items.keyword_info.monthly_searches.search_volume
integer

monthly average search volume rate

​
tasks.result.items.keyword_info.search_volume_trend
object

search volume trend changes represents search volume change in percent compared to the previous period

​
tasks.result.items.keyword_info.search_volume_trend.monthly
integer

search volume change in percent compared to the previous month

​
tasks.result.items.keyword_info.search_volume_trend.quarterly
integer

search volume change in percent compared to the previous quarter

​
tasks.result.items.keyword_info.search_volume_trend.yearly
integer

search volume change in percent compared to the previous year

​
tasks.result.items.keyword_info.keyword_info_normalized_with_bing
object

contains keyword search volume normalized with Bing search volume

​
tasks.result.items.keyword_info.keyword_info_normalized_with_bing.last_updated_time
string

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

​
tasks.result.items.keyword_info.keyword_info_normalized_with_bing.search_volume
integer

current search volume rate of a keyword

​
tasks.result.items.keyword_info.keyword_info_normalized_with_bing.is_normalized
boolean

keyword info is normalized if true, values are normalized with Bing data

​
tasks.result.items.keyword_info.keyword_info_normalized_with_bing.monthly_searches
integer

monthly search volume rates array of objects with search volume rates in a certain month of a year

​
tasks.result.items.keyword_info.keyword_info_normalized_with_bing.monthly_searches.year
integer

year

​
tasks.result.items.keyword_info.keyword_info_normalized_with_bing.monthly_searches.month
integer

month

​
tasks.result.items.keyword_info.keyword_info_normalized_with_bing.monthly_searches.search_volume
integer

search volume rate in a certain month of a year

​
tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream
object

contains keyword search volume normalized with clickstream data

​
tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.last_updated_time
string

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

​
tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.search_volume
integer

current search volume rate of a keyword

​
tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.is_normalized
boolean

keyword info is normalized if true, values are normalized with clickstream data

​
tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.monthly_searches
integer

monthly search volume rates array of objects with search volume rates in a certain month of a year

​
tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.monthly_searches.year
integer

year

​
tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.monthly_searches.month
integer

month

​
tasks.result.items.keyword_info.keyword_info_normalized_with_clickstream.monthly_searches.search_volume
integer

search volume rate in a certain month of a year

​
tasks.result.items.clickstream_keyword_info
object

clickstream data for the returned keyword to retrieve results for this field, the parameter include_clickstream_data must be set to true

​
tasks.result.items.clickstream_keyword_info.search_volume
integer

monthly average clickstream search volume rate

​
tasks.result.items.clickstream_keyword_info.last_updated_time
string

date and time when the clickstream dataset was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”

​
tasks.result.items.clickstream_keyword_info.gender_distribution
object

distribution of estimated clickstream-based metrics by gender learn more about how the metric is calculated in this help center article

​
tasks.result.items.clickstream_keyword_info.gender_distribution.female
integer

number of female users in the relevant clickstream dataset

​
tasks.result.items.clickstream_keyword_info.gender_distribution.male
integer

number of male users in the relevant clickstream dataset

​
tasks.result.items.clickstream_keyword_info.age_distribution
object

distribution of clickstream-based metrics by age learn more about how the metric is calculated in this help center article

​
tasks.result.items.clickstream_keyword_info.age_distribution.18-24
integer

number of users in the relevant clickstream dataset that fall within the 18-24 age range

​
tasks.result.items.clickstream_keyword_info.age_distribution.25-34
integer

number of users in the relevant clickstream dataset that fall within the 25-34 age range

​
tasks.result.items.clickstream_keyword_info.age_distribution.35-44
integer

number of users in the relevant clickstream dataset that fall within the 35-44 age range

​
tasks.result.items.clickstream_keyword_info.age_distribution.45-54
integer

number of users in the relevant clickstream dataset that fall within the 45-54 age range

​
tasks.result.items.clickstream_keyword_info.age_distribution.55-64
integer

number of users in the relevant clickstream dataset that fall within the 55-64 age range

​
tasks.result.items.clickstream_keyword_info.monthly_searches
string[]

monthly clickstream search volume rates array of objects with clickstream search volume rates in a certain month of a year

​
tasks.result.items.clickstream_keyword_info.monthly_searches.year
integer

year

​
tasks.result.items.clickstream_keyword_info.monthly_searches.month
integer

month

​
tasks.result.items.clickstream_keyword_info.monthly_searches.search_volume
integer

clickstream-based search volume rate in a certain month of a year

​
tasks.result.items.keyword_properties
object

additional information about the keyword

​
tasks.result.items.keyword_properties.se_type
string

search engine type

​
tasks.result.items.keyword_properties.core_keyword
string

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

​
tasks.result.items.keyword_properties.synonym_clustering_algorithm
string

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

​
tasks.result.items.keyword_properties.keyword_difficulty
integer

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

​
tasks.result.items.keyword_properties.detected_language
string

detected language of the keyword indicates the language of the keyword as identified by our system

​
tasks.result.items.keyword_properties.is_another_language
boolean

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

​
tasks.result.items.serp_info
object

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

​
tasks.result.items.serp_info.se_type
string

search engine type

​
tasks.result.items.serp_info.check_url
string

direct URL to search engine results you can use it to make sure that we provided accurate results

​
tasks.result.items.serp_info.serp_item_types
string[]

types of search results in SERP contains types of search results (items) found in SERP possible items 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

​
tasks.result.items.serp_info.se_results_count
string

number of search results for the returned keyword

​
tasks.result.items.serp_info.last_updated_time
string

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

​
tasks.result.items.serp_info.previous_updated_time
string

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

​
tasks.result.items.avg_backlinks_info
object

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 websites ranking organically for the keyword

​
tasks.result.items.avg_backlinks_info.se_type
string

search engine type

​
tasks.result.items.avg_backlinks_info.backlinks
number

average number of backlinks

​
tasks.result.items.avg_backlinks_info.dofollow
number

average number of dofollow links

​
tasks.result.items.avg_backlinks_info.referring_pages
number

average number of referring pages

​
tasks.result.items.avg_backlinks_info.referring_domains
number

average number of referring domains

​
tasks.result.items.avg_backlinks_info.referring_main_domains
number

average number of referring main domains

​
tasks.result.items.avg_backlinks_info.rank
number

average rank learn more about the metric and its calculation formula in this help center article

​
tasks.result.items.avg_backlinks_info.main_domain_rank
number

average main domain rank learn more about the metric and its calculation formula in this help center article

​
tasks.result.items.avg_backlinks_info.last_updated_time
string

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

​
tasks.result.items.search_intent_info
object

search intent info for the returned keyword learn about search intent in this help center article

​
tasks.result.items.search_intent_info.se_type
string

search engine type possible values: google

​
tasks.result.items.search_intent_info.main_intent
string

main search intent possible values: informational, navigational, commercial, transactional

​
tasks.result.items.search_intent_info.foreign_intent
string[]

supplementary search intents possible values: informational, navigational, commercial, transactional

​
tasks.result.items.search_intent_info.last_updated_time
string

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