Docs
Search docs...⌘K

Keywords

API + MCP
GET/v3/gsc/keywords

Requests to this endpoint are free and do not consume any API units.

Query parameters

keyword_listsstring

Keyword lists filter (JSON string). Supports include (is), exclude (is_not), empty (not in any list), and not_empty (in any list).

keyword_list_idinteger

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

wherestring

Supported fields:

limitinteger

The number of results to return.

Default:1000
devicestring

Filter by device type (DESKTOP, MOBILE, TABLET). If not specified, all devices are included.

Allowed values:desktopmobiletablet
countrystring

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

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
search_typestring

The type of search results to return (web, image, video, news).

Allowed values:webimagevideonews
Default:web
date_tostring (date)

The end date of the historical period in YYYY-MM-DD format.

date_fromstring (date)Required

The start date of the historical period in YYYY-MM-DD format.

portfolio_idinteger

Portfolio ID. When provided, aggregates data across all GSC-connected projects in the portfolio.

project_idinteger

Project ID. Required when portfolio_id is not provided.

outputstring

The output format.

Allowed values:jsoncsvxmlphp

Responses

keywordsarray<object>
keywordstring
urls_countinteger
top_urlstring (url) or null
clicksinteger or null
impressionsinteger or null
ctrnumber (float) or null
positionnumber (float) or null

Average position (decimal, e.g. 4.7)

keyword_list_labelsarray<string>