Топ за ключовою фразою

Метод SerpstatKeywordProcedure.getKeywordTop повертає останній топ-100 Google по ключовій фразі. Аналогічний до звіту Топ по фразі в Аналізі ключових слів.

Загальні параметри запиту та інструкція щодо використання Serpstat API

Доступні пошукові бази

Параметри запиту
Параметр	Опис	Тип даних	Опціональний	Значення за замовчуванням	Варіанти значень
id	Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор. Допускається введення будь-якого числового (number) або текстового (string) значення	int/string	ні		1, test
method	Назва методу API	string	ні		SerpstatKeywordProcedure.getKeywordTop
params	Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...]	array	ні
keyword	Фраза, для якої буде відбуватися пошук	string	ні		iphone
se	Ідентифікатор пошукової бази, по якій буде проходити пошук.	string	ні		g_us
filters	Умови фильтраціі	int	так	{"top_size": 100}	"top_size": 100 "position": 1 "position_from": 2 "position_to": 10 "url": https://www.apple.com/iphone/ "exact_url": https://www.apple.com/iphone-13-pro/ "domain": www.apple.com "minus_domain": www.blackberry.com "subdomain": developer.apple.com

Параметри відповіді
Параметр	Опис
id	Ідентифікатор відповіді: відповідає id в запиті
result	Містить в собі відповідь
data	Масив з даними
top	Містить в собі відповідь
position	Позиція домену за ключовою фразою в пошуковій видачі
url	Сторінка, яка знаходиться на вказаній позиції
domain	Домен, який ранжується за ключовою фразою
subdomain	Піддомен сайту, який відображається в пошуковій видачі за заданною фразою
types	Список додаткових елементів які відображаються в SERP (наприклад, відео, карусель зображень, карта та інше)
ads	Містить результати контекстної реклами (якщо вона є)
results	Кількість результатів
summary_info	Об'єкт з даними відповіді
page	Номер сторінки
left_lines	Кількість API рядків, що залишилися

Ліміти: кількість списаних лімітів відповідає кількості отриманих ключових фраз у відповіді. За один запит можна отримати не більше 60000 результатів. Частина відповіді API, за яку знімається 1 ліміт:

{
    "position": 1,
    "url": "https://www.apple.com/iphone/",
    "domain": "apple.com",
    "subdomain": "www.apple.com",
    "types": [
        "shopping_top",
        "kn_graph_carousel_list",
        "also_asks",
        "snip_breadcrumbs"
        ]
},

Example

Request data:

{
 "id": "1",
 "method": "SerpstatKeywordProcedure.getKeywordTop",
 "params": {
   "keyword": "iphone",
   "se": "g_us",
   "filters": {"top_size": "10"}
 }
}

Response data:

{
    "id": "1",
    "result": {
        "data": {
            "top": [
                {
                    "position": 1,
                    "url": "https://www.apple.com/iphone/",
                    "domain": "apple.com",
                    "subdomain": "www.apple.com",
                    "types": [
                        "shopping_top",
                        "kn_graph_carousel_list",
                        "also_asks",
                        "snip_breadcrumbs"
                    ]
                },
                {
                    "position": 2,
                    "url": "https://www.apple.com/",
                    "domain": "apple.com",
                    "subdomain": "www.apple.com",
                    "types": [
                        "shopping_top",
                        "kn_graph_carousel_list",
                        "also_asks",
                        "snip_breadcrumbs"
                    ]
                }
            ],
            "ads": [],
            "types": [
                "shopping_top",
                "kn_graph_carousel_list",
                "also_asks"
            ],
            "results": 79
        },
        "summary_info": {
            "page": 1,
            "left_lines": 998661
        }
    }
}