Docs
Search docs...⌘K

Overview

GET/v3/keywords-explorer/overview

The regex filter has limited functionality when used in this request, and the syntax differs from other requests. It expects an asterisk (*) symbol as a wildcard.

Query parameters

timeoutinteger

A manual timeout duration in seconds.

limitinteger

The number of results to return.

Default:1000
order_bystring

A column to order results by. See the response schema for valid column identifiers, except for volume_monthly, which is not supported in order_by for this endpoint.

wherestring

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the select parameter).

clicks: The average monthly number of clicks on the search results that people make while searching for the target keyword.
type: integer nullable

cpc: Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword, in USD cents.
type: integer nullable

cps: Clicks Per Search (or CPS) is the ratio of Clicks to Keyword Search volume. It shows how many different search results get clicked, on average, when people search for the target keyword in a given country.
type: float nullable

difficulty (10 units): An estimation of how hard it is to rank in the top 10 organic search results for a keyword on a 100-point scale.
type: integer nullable

first_seen: The date when we first checked search engine results for a keyword.
type: datetime nullable

global_volume (10 units): How many times per month, on average, people search for the target keyword across all countries in our database.
type: integer nullable

intents (10 units): Indicates the purpose behind the user's search query. Object fields: informational, navigational, commercial, transactional, branded or local. All the fields are of type bool, with possible values true or false.
type: object nullable

keyword:
type: string

parent_topic: Parent Topic determines if you can rank for your target keyword while targeting a more general topic on your page instead. To identify the Parent Topic, we take the #1 ranking page for your keyword and find the keyword responsible for sending the most traffic to that page.
type: string nullable

parent_volume (10 units): The search volume of the parent topic.
type: integer nullable

serp_domain_rating_top10_min: The keyword must have at least one ranking position in the top 10 results with a DR of up to this value.
type: float nullable

serp_domain_rating_top5_min: The keyword must have at least one ranking position in the top 5 results with a DR of up to this value.
type: float nullable

serp_features: The enriched results on a search engine results page (SERP) that are not traditional organic results.
type: array(string)
enum: "ai_overview_sitelink" "snippet" "ai_overview" "local_pack" "sitelink" "news" "image" "video" "discussion" "tweet" "paid_top" "paid_bottom" "paid_sitelink" "shopping" "knowledge_card" "knowledge_panel" "question" "image_th" "video_th" "organic_shopping"

serp_last_update: The date when we last checked search engine results for a keyword.
type: datetime nullable

traffic_potential (10 units): The sum of organic traffic that the #1 ranking page for your target keyword receives from all the keywords that it ranks for.
type: integer nullable

volume (10 units): An estimation of the average monthly number of searches for a keyword over the latest known 12 months of data.
type: integer nullable

volume_desktop_pct: The percentage of searches for a keyword performed on desktop devices.
type: float nullable

volume_mobile_pct: The percentage of searches for a keyword performed on mobile devices.
type: float nullable

word_count:
type: integer

selectstringRequired

A comma-separated list of columns to return. See response schema for valid column identifiers.

volume_monthly_date_tostring

The end date in YYYY-MM-DD format for retrieving historical monthly search volumes in the volume_monthly_history field. Required only if volume_monthly_history is requested.

volume_monthly_date_fromstring

The start date in YYYY-MM-DD format for retrieving historical monthly search volumes in the volume_monthly_history field. Required only if volume_monthly_history is requested.

target_modestring

The scope of the target URL you specified.

Allowed values:exactprefixdomainsubdomains
targetstring

The target of the search: a domain or a URL.

target_positionstring

Filters keywords based on the ranking position of the specified target.

Allowed values:in_top10in_top100
countrystringRequired

A two-letter country code (ISO 3166-1 alpha-2).

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
search_enginestring

[Deprecated on 5 Aug 2024].

Allowed values:google
Default:google
keywordsstring

A comma-separated list of keywords to show metrics for.

keyword_list_idinteger

The id of an existing keyword list to show metrics for.

outputstring

The output format.

Allowed values:jsoncsvxmlphp

Responses

keywordsarray
clicksinteger or null

The average monthly number of clicks on the search results that people make while searching for the target keyword.

cpcinteger or null

Cost Per Click shows the average price that advertisers pay for each ad click in paid search results for a keyword, in USD cents.

cpsnumber or null

Clicks Per Search (or CPS) is the ratio of Clicks to Keyword Search volume. It shows how many different search results get clicked, on average, when people search for the target keyword in a given country.

difficultyinteger or null

(10 units) An estimation of how hard it is to rank in the top 10 organic search results for a keyword on a 100-point scale.

first_seenstring or null

The date when we first checked search engine results for a keyword.

global_volumeinteger or null

(10 units) How many times per month, on average, people search for the target keyword across all countries in our database.

intentsobject or null

(10 units) Indicates the purpose behind the user's search query. Object fields: informational, navigational, commercial, transactional, branded or local. All the fields are of type bool, with possible values true or false.

keywordstring
parent_topicstring or null

Parent Topic determines if you can rank for your target keyword while targeting a more general topic on your page instead. To identify the Parent Topic, we take the #1 ranking page for your keyword and find the keyword responsible for sending the most traffic to that page.

parent_volumeinteger or null

(10 units) The search volume of the parent topic.

searches_pct_clicks_organic_and_paidnumber or null

The average monthly percentage of people who clicked on both organic and paid results while searching for the target keyword.

searches_pct_clicks_organic_onlynumber or null

The average monthly percentage of people who clicked only on organic results while searching for the target keyword.

searches_pct_clicks_paid_onlynumber or null

The average monthly percentage of people who clicked only on paid results while searching for the target keyword.

serp_featuresarray

The enriched results on a search engine results page (SERP) that are not traditional organic results.

serp_last_updatestring or null

The date when we last checked search engine results for a keyword.

traffic_potentialinteger or null

(10 units) The sum of organic traffic that the #1 ranking page for your target keyword receives from all the keywords that it ranks for.

volumeinteger or null

(10 units) An estimation of the average monthly number of searches for a keyword over the latest known 12 months of data.

volume_desktop_pctnumber or null

The percentage of searches for a keyword performed on desktop devices.

volume_mobile_pctnumber or null

The percentage of searches for a keyword performed on mobile devices.

volume_monthlyinteger or null

(10 units) An estimation of the number of searches for a keyword over the latest month. This field may not be included in the order_by parameter

volume_monthly_historyarray

(2 units per historical month, with a minimum of 50 units) Historical monthly search volume estimates of a keyword for the period set by the volume_monthly_date_from and volume_monthly_date_to parameters.