GET /serp-overview

Servers

Query parameters

Name Type Required Description
top_positions Integer No

The number of top organic SERP positions to return. If not specified, all available positions will be returned.

output String No

The output format.

Possible values:

  • "csv"
  • "json"
  • "xml"
  • "php"
keyword String Yes

The keyword to return SERP Overview for.

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"
date String No

A timestamp on which the last available SERP Overview is returned in YYYY-MM-DDThh:mm:ss format. If it is not specified, the most recent SERP Overview is returned.

select String Yes

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

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.