GET /overview

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

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: "snippet" "local_pack" "sitelink" "news" "image" "video" "discussion" "tweet" "paid_top" "paid_bottom" "paid_sitelink" "shopping" "knowledge_card" "knowledge_panel" "question" "image_th" "video_th"

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

word_count:
type: integer

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

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

The number of results to return.

The output format.

Possible values:

• "csv"
• "json"
• "xml"
• "php"

A manual timeout duration in seconds.

The search engine to get keyword metrics for.

Possible values:

• "yahoo"
• "yandex"
• "naver"
• "seznam"
• "google"
• "amazon"
• "daum"
• "youtube"
• "bing"
• "baidu"

Default value: "google"

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

Possible values:

• "bo"
• "am"
• "ls"
• "mu"
• "jo"
• "hk"
• "im"
• "gi"
• "tr"
• "md"
• "lb"
• "gy"
• "cr"
• "sa"
• "mv"
• "kr"
• "lt"
• "in"
• "jp"
• "ee"
• "ca"
• "ro"
• "pk"
• "ng"
• "lc"
• "me"
• "vg"
• "sb"
• "td"
• "ao"
• "lu"
• "mw"
• "fi"
• "eg"
• "de"
• "sr"
• "tt"
• "pl"
• "br"
• "sc"
• "mx"
• "nz"
• "lv"
• "za"
• "gl"
• "hn"
• "fj"
• "st"
• "cd"
• "ba"
• "ni"
• "mg"
• "vi"
• "ug"
• "my"
• "iq"
• "gm"
• "tw"
• "uy"
• "rs"
• "bb"
• "pn"
• "cu"
• "bs"
• "qa"
• "mz"
• "gn"
• "uz"
• "sv"
• "cf"
• "bd"
• "om"
• "ke"
• "tg"
• "cv"
• "bt"
• "ar"
• "se"
• "ly"
• "kw"
• "is"
• "fm"
• "cg"
• "ru"
• "be"
• "nl"
• "th"
• "as"
• "it"
• "gp"
• "hr"
• "dj"
• "ch"
• "tz"
• "bf"
• "ad"
• "pr"
• "li"
• "mk"
• "je"
• "kg"
• "dz"
• "re"
• "at"
• "sg"
• "pa"
• "ky"
• "fo"
• "gq"
• "dk"
• "ci"
• "rw"
• "bg"
• "ae"
• "ps"
• "no"
• "ml"
• "kh"
• "id"
• "yt"
• "vn"
• "cy"
• "sh"
• "bw"
• "tj"
• "au"
• "kz"
• "gr"
• "ht"
• "ye"
• "bh"
• "af"
• "pt"
• "mn"
• "np"
• "lk"
• "mm"
• "zw"
• "ki"
• "ie"
• "ga"
• "tk"
• "cz"
• "si"
• "hu"
• "dm"
• "ck"
• "bi"
• "ag"
• "gb"
• "by"
• "tl"
• "aw"
• "gt"
• "fr"
• "cl"
• "bj"
• "nr"
• "ws"
• "tm"
• "bz"
• "sk"
• "pe"
• "na"
• "gu"
• "do"
• "cm"
• "ai"
• "mq"
• "gd"
• "sl"
• "tn"
• "pf"
• "vc"
• "cn"
• "ua"
• "mr"
• "kn"
• "ge"
• "to"
• "az"
• "sm"
• "pg"
• "nc"
• "ma"
• "es"
• "co"
• "py"
• "nu"
• "ms"
• "jm"
• "gf"
• "sn"
• "ph"
• "ve"
• "et"
• "bn"
• "al"
• "mt"
• "il"
• "gh"
• "vu"
• "gg"
• "ec"
• "us"
• "so"
• "ne"
• "la"
• "mc"
• "zm"

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

[Deprecates on 31 May 2024] Returned results will start from the row indicated in the offset value.

A column to order results by. See response schema for valid column identifiers.