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

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

API + MCP
GET/v3/gsc/keywords

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

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

project_idinteger

Ідентифікатор проєкту. Обов’язковий, якщо portfolio_id не вказано.

portfolio_idinteger

Ідентифікатор портфоліо. Якщо його вказано, агрегує дані за всіма підключеними до GSC проєктами в межах портфоліо.

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

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

date_tostring (date)

Дата завершення історичного періоду у форматі YYYY-MM-DD.

search_typestring

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

Дозволені значення:webimagevideonews
За Замовчуванням:web
countrystring

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

Дозволені значення:adaeafagaialamaoarasatauawazba…
devicestring

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

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

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

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

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

keyword_list_idinteger

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

keyword_listsstring

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

outputstring

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

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

Відповіді

keywordsarray<object>
clicksinteger or null
ctrnumber (float) or null
impressionsinteger or null
keywordstring
keyword_list_labelsarray<string>
positionnumber (float) or null

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

top_urlstring (url) or null
urls_countinteger