Docs
Пошук документації...⌘K

Ключові слова

API + MCP
GET/v3/gsc/keywords

Запити до цього ендпоїнта безкоштовні та не витрачають жодних одиниць API.

Параметри запиту

keyword_listsstring

Фільтр списків ключових слів (рядок JSON). Підтримує включення (is), виключення (is_not), порожнє значення (not in any list) і непорожнє значення (in any list).

keyword_list_idinteger

Ідентифікатор наявного списку ключових слів, для якого потрібно показувати метрики.

wherestring

Підтримувані поля:

limitinteger

Кількість результатів, які потрібно повернути.

За Замовчуванням:1000
devicestring

Фільтр за типом пристрою (DESKTOP, MOBILE, TABLET). Якщо не вказано, включаються всі пристрої.

Дозволені значення:desktopmobiletablet
countrystring

Дволітерний код країни (ISO 3166-1 alpha-2).

Дозволені значення:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
search_typestring

Тип результатів пошуку, які потрібно повернути (web, image, video, news).

Дозволені значення:webimagevideonews
За Замовчуванням:web
date_tostring (date)

Кінцева дата історичного періоду у форматі YYYY-MM-DD.

date_fromstring (date)Обов’язково

Початкова дата історичного періоду у форматі YYYY-MM-DD.

portfolio_idinteger

ID Portfolio. Якщо вказано, агрегує дані з усіх проєктів у Portfolio, підключених до GSC.

project_idinteger

ID Проєкту. Обов'язково, якщо portfolio_id не вказано.

outputstring

Формат виводу.

Дозволені значення:jsoncsvxmlphp

Відповіді

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

Середня позиція (десяткове число, наприклад 4.7)

keyword_list_labelsarray<string>