Список URL-адресов домена V4 (SerpstatDomainProcedure.getDomainUrls)

Метод SerpstatDomainProcedure.getDomainUrls возвращает URL домена и количество ключевых слов для URL. Аналогичен отчету «Страницы-лидеры» в Анализе домена, за вычетом информации по трафику и количеству шейров в Facebook.

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

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

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

Параметры ответа
Параметр	Описание
id	Идентификатор запроса: соответствует id в запросе
result	Содержит в себе ответ
data	Массив с данными ответа
url	Страница домена
keywords	Количество ключевых фраз, по которой ранжируется данная страница
summary_info	Объект с данными ответа
page	Номер страницы
total	Количество найденных URL
left_lines	Количество оставшихся API строк

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

{
    "url": "https://www.nike.com/",
    "keywords": 64785
},

Example

Request data:

{
 "id": "1",
 "method": "SerpstatDomainProcedure.getDomainUrls",
 "params": {
   "domain": "nike.com",
   "se": "g_us",
   "sort": {"keywords": "desc"},
   "page": "1",
   "size": "3"
 }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "url": "https://www.nike.com/",
                "keywords": 64785
            },
            {
                "url": "https://jobs.nike.com/",
                "keywords": 21450
            },
            {
                "url": "https://www.nike.com/w/womens-tops-t-shirts-5e1x6z9om13",
                "keywords": 16472
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 147457,
            "left_lines": 997007
        }
    }
}