GET /organic-keywords

Servers

Query parameters

Name Type Required Description
where String No

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

best_position: The top position your target ranks for in the organic search results for a keyword.
type: integer nullable

best_position_diff: The change in position between your selected dates.
type: integer nullable

best_position_has_thumbnail: The top position has a thumbnail.
type: boolean nullable

best_position_has_thumbnail_prev: The top position has a thumbnail on the comparison date.
type: boolean nullable

best_position_has_video: The top position has a video.
type: boolean nullable

best_position_has_video_prev: The top position has a video on the comparison date.
type: boolean nullable

best_position_kind: The kind of the top position: organic, paid, or a SERP feature.
type: string nullable
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion"

best_position_kind_merged: The kind of the top position optimized for sorting.
type: string
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion"

best_position_kind_prev: The kind of the top position on the comparison date.
type: string nullable
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion"

best_position_prev: The top position on the comparison date.
type: integer nullable

best_position_set: The ranking group of the top position.
type: string
enum: "top_3" "top_4_10" "top_11_50" "top_51_more"

best_position_set_prev: The ranking group of the top position on the comparison date.
type: string nullable
enum: "top_3" "top_4_10" "top_11_50" "top_51_more"

best_position_url: The ranking URL in organic search results.
type: string nullable

best_position_url_prev: The ranking URL on the comparison date.
type: string nullable

best_position_url_raw: The ranking page URL in encoded format.
type: string nullable

best_position_url_raw_prev: The ranking page URL on the comparison date in encoded format.
type: string 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

cpc_merged: The CPC field optimized for sorting.
type: integer nullable

cpc_prev: The CPC metric on the comparison date.
type: integer nullable

is_best_position_set_top_11_50: The ranking group of the top position is 11-50.
type: boolean

is_best_position_set_top_11_50_prev: The ranking group of the top position was 11-50 on the comparison date.
type: boolean nullable

is_best_position_set_top_3: The ranking group of the top position is Top 3.
type: boolean

is_best_position_set_top_3_prev: The ranking group of the top position was Top 3 on the comparison date.
type: boolean nullable

is_best_position_set_top_4_10: The ranking group of the top position is 4-10.
type: boolean

is_best_position_set_top_4_10_prev: The ranking group of the top position was 4-10 on the comparison date.
type: boolean nullable

is_main_position: Excludes positions in Sitelinks, Top stories, Image packs, and posts on X (Twitter).
type: boolean

is_main_position_prev: Excludes positions in Sitelinks, Top stories, Image packs, and posts on X (Twitter) on the comparison date.
type: boolean

keyword: The keyword your target ranks for.
type: string

keyword_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

keyword_difficulty_merged (10 units): The keyword difficulty field optimized for sorting.
type: integer nullable

keyword_difficulty_prev (10 units): The keyword difficulty on the comparison date.
type: integer nullable

keyword_merged: The keyword field optimized for sorting.
type: string

keyword_prev: The keyword your target ranks for on the comparison date.
type: string

language: The SERP language.
type: string

language_prev: The SERP language on the comparison date.
type: string nullable

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

last_update_prev: The date when we checked search engine results up to the comparison date.
type: datetime nullable

position_kind: The kind of a position: organic, paid or a SERP feature. This applies to all positions for a given keyword and URL before picking the top position.
type: string
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion"

position_kind_prev: The kind of a position on the comparison date.
type: string
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion"

serp_features: The SERP features that appear in search results for a keyword.
type: array(string)
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion" "image_th" "video_th"

serp_features_count: The number of SERP features that appear in search results for a keyword.
type: integer

serp_features_count_prev: The number of SERP features on the comparison date.
type: integer nullable

serp_features_merged: The SERP features field optimized for sorting.
type: array(string)
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion" "image_th" "video_th"

serp_features_prev: The SERP features on the comparison date.
type: array(string)
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion" "image_th" "video_th"

serp_target_main_positions_count: The number of target URLs ranking for a keyword excluding positions in Sitelinks, Top stories, Image packs, and posts on X (Twitter).
type: integer

serp_target_main_positions_count_prev: The number of target URLs ranking for a keyword excluding positions in Sitelinks, Top stories, Image packs, and posts on X (Twitter) on the comparison date.
type: integer nullable

serp_target_positions_count: The number of target URLs ranking for a keyword.
type: integer

serp_target_positions_count_prev: The number of target URLs ranking for a keyword on the comparison date.
type: integer nullable

status: The status of a page: the new page that just started to rank ("left"), the lost page that disappeared from search results ("right"), or no change ("both").
type: string
enum: "left" "right" "both"

sum_paid_traffic (10 units): An estimation of the number of monthly visits that your target gets from paid search for a keyword.
type: integer nullable

sum_traffic (10 units): An estimation of the number of monthly visitors that your target gets from organic search for a keyword.
type: integer nullable

sum_traffic_merged (10 units): The traffic field optimized for sorting.
type: integer

sum_traffic_prev (10 units): The traffic on the comparison date.
type: integer nullable

title: The title displayed for the page in a keyword's SERP.
type: string

title_prev: The title displayed for the page in a keyword's SERP on the comparison date.
type: string

volume (10 units): An estimation of the number of searches for a keyword over the latest month.
type: integer nullable

volume_merged (10 units): The search volume field optimized for sorting.
type: integer nullable

volume_prev (10 units): The search volume on the comparison date.
type: integer nullable

words: The number of words in a keyword.
type: integer

words_merged: The number of words in a keyword optimized for sorting.
type: integer

words_prev: The number of words in a keyword on the comparison date.
type: integer

volume_mode String No

The search volume calculation mode: monthly or average. It affects volume, traffic, and traffic value.

Possible values:

  • "average"
  • "monthly"

Default value: "monthly"

protocol String No

The protocol of your target.

Possible values:

  • "both"
  • "http"
  • "https"

Default value: "both"

output String No

The output format.

Possible values:

  • "csv"
  • "json"
  • "xml"
  • "php"
mode String No

The scope of the search based on the target you entered.

Possible values:

  • "exact"
  • "domain"
  • "prefix"
  • "subdomains"

Default value: "subdomains"

date String Yes

A date to report metrics on in YYYY-MM-DD format.

select String Yes

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

order_by String No

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

limit Integer No

The number of results to return.

target String Yes

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

timeout Integer No

A manual timeout duration in seconds.

date_compared String No

A date to compare metrics with in YYYY-MM-DD format.

country String Yes

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"
offset Integer No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.