Страницы-лидеры домена V4 (SerpstatDomainProcedure.getTopUrls)

Метод SerpstatDomainProcedure.getTopUrls возвращает количество ключевых фраз, по которым страница ранжируется в топе (топ-100 Google или топ-50 Яндекс), ориентировочный трафик страниц и количество шейров в социальной сети Facebook. Аналогичен отчету «Страницы-лидеры» в Анализе домена.

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

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

Данный метод может работать продолжительное время, из-за специфики сбора данных. По умолчанию результаты отсортированы по количеству фраз, по убыванию.

Параметры запроса
Параметр	Описание	Опциональный	Значение по умолчанию	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения.	нет		1, test
method	Название метода API	нет		SerpstatDomainProcedure.getTopUrls
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]	нет
domain	Имя домена	нет		nike.com
se	Идентификатор поисковой базы, по которой будет проходить поиск (доступны базы Google и Yandex на выбор, пример: g_us, y_157).	нет		g_us
sort	Порядок сортировки результатов в формате: {{{field}}: {{order}}} field - поле, по которому нужно выполнить сортировку: * organic_keywords * facebook_shares * potencial_traff order - направление сортировки (asc — по возрастанию, desc — по убыванию)	да	{"organic_keywords":"desc"}	{"organic_keywords":"asc"}
filters	Условия фильтрации	да		{"url_prefix": "https://www.nike.com/nike-by-you"} {"url_contain": "nike-by-you"} {"url_not_contain": "nike-by-you"}
page	Номер страницы в ответе	да	1	"page": "1"
size	Количество результатов на страницу в ответе	да	100	"size": "50" min: 50, max: 1000

Параметры ответа
Параметр	Описание
id	Идентификатор запроса: соответствует id в запросе
result	Содержит в себе ответ
data	Массив с данными ответа
url	Страница домена
organic_keywords	Общее количество ключевых фраз, по которым ранжируется страница в Google топ-100 или Яндекс топ-50
facebook_shares	Количество шейров (репостов) в социальной сети Facebook
potencial_traff	Ориентировочный трафик страницы по ключевому слову в зависимости от частотности ключа и позиции домена.
total	Всего найденных результатов
left_lines	Количество оставшихся API строк

Лимиты: количество списанных лимитов соответствует количеству полученных результатов по запросу. Часть ответа API, за которую снимается 1 лимит:

{
    "url": "https://www.nike.com/id/w/nike-by-you-running-shoes-37v7jz6ealhzy7ok",
    "organic_keywords": 39,
    "facebook_shares": 0,
    "potencial_traff": 540
},

Example

Request data:

{
 "id": "1",
 "method": "SerpstatDomainProcedure.getTopUrls",
 "params": {
   "domain": "nike.com",
   "se": "g_us",
   "sort": {"organic_keywords":"asc"},	
   "filters": {"url_contain": "nike-by-you"},
   "page": "1",
   "size": "50"
 }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "url": "https://www.nike.com/id/w/nike-by-you-running-shoes-37v7jz6ealhzy7ok",
                "organic_keywords": 39,
                "facebook_shares": 0,
                "potencial_traff": 540
            },
            {
                "url": "https://www.nike.com/w/nike-by-you-metcon-shoes-3yxqsz6ealhzy7ok",
                "organic_keywords": 40,
                "facebook_shares": 0,
                "potencial_traff": 511
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 490,
            "left_lines": 999217
        }
    }
}