Список URL-адресов, конкурирующих с указанной страницей V4 (SerpstatUrlProcedure.getUrlCompetitors)

Метод SerpstatUrlProcedure.getUrlCompetitors возвращает cписок URL-адресов, конкурирующих с заданной страницей. Аналогичен отчету «Конкуренты» в Анализе страниц.

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

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

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

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

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

{
    "domain": "footlocker.com",
    "url": "https://www.footlocker.com/category/brands/nike.html",
    "cnt": 75
},

Example

Request data:

{
    "id": "1",
    "method": "SerpstatUrlProcedure.getUrlCompetitors",
    "params": {
     "se": "g_us",
     "url": "https://www.nike.com",
     "sort": {"cnt": "desc"},
     "page": "1",
     "size": "10"
 }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "domain": "footlocker.com",
                "url": "https://www.footlocker.com/category/brands/nike.html",
                "cnt": 75
            },
            {
                "domain": "nike.com",
                "url": "https://www.nike.com/w/sale-3yaep",
                "cnt": 49
            },
            {
                "domain": "finishline.com",
                "url": "https://www.finishline.com/nike",
                "cnt": 40
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 356,
            "left_lines": 998149
        }
    }
}