Топ по ключевой фразе V4 (SerpstatKeywordProcedure.getKeywordTop)

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

Общие параметры запроса и инструкция по использованию Serpstat API

Перечень доступных баз и стран

Параметры запроса
Параметр	Описание	Тип данных	Опциональный	Значение по умолчанию	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения.	int/string	нет		1, test
method	Название метода API	string	нет		SerpstatKeywordProcedure.getKeywordTop
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]	array	нет
keyword	Фраза, для которой будет происходить поиск	string	нет		iphone
se	Идентификатор поисковой базы, по которой будет проходить поиск (доступны базы Google и Yandex на выбор, пример: g_us, y_157).	string	нет		g_us
filters	Условия фильтрации	int	да	{"top_size": 100}	{"top_size": 100} top_size цифровое значение от 1 до 100

Параметры ответа
Параметр	Описание
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
        }
    }
}