Список конкурентов по ключевой фразе в PPC V4 (SerpstatKeywordProcedure.getAdsCompetitors)

Метод SerpstatKeywordProcedure.getAdsCompetitors выполняет поиск доменов-конкурентов в РРС по ключевой фразе. Аналогичен отчету «Конкуренты» в PPC-анализе по ключевой фразе.

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

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

Параметры запроса
Параметр	Описание	Тип	Опциональный	Значение по умолчанию	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения.	int/string	нет		1, test
method	Название метода API	string	нет		SerpstatKeywordProcedure.getAdsCompetitors
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]	array	нет
query	Фраза, для которой будет происходить поиск	string	нет		iphone
se	Идентификатор поисковой базы, по которой будет проходить поиск (доступны базы Google и Yandex на выбор, пример: g_us, y_157).	string	нет		g_us
page	Номер страницы в ответе	int	да	1	"page": "5"
pageSize	Количество результатов на страницу в ответе	int	да	100	"pageSize": "100" min: 100, max: 1000
sort	Порядок сортировки результатов в формате: {{{field}}: {{order}}} field — поле, по которому нужно выполнить сортировку: * ads * all * common order — направление сортировки (asc — по возрастанию, desc — по убыванию)	json object	да		{"common": "desc"}

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

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

{
    "domain": "verizon.com",
    "ads": 8953,
    "all": 30855,
    "common": 1437
},

Example

Request data:

{
 "id": "1",
 "method": "SerpstatKeywordProcedure.getAdsCompetitors",
 "params": {
   "query": "iphone",
   "se": "g_us",
   "page": "1",
   "pageSize": "100",
     "sort": {
            "common": "desc"
        }
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "domain": "verizon.com",
                "ads": 8953,
                "all": 30855,
                "common": 1437
            },
            {
                "domain": "apple.com",
                "ads": 4018,
                "all": 6164,
                "common": 488
            },
            {
                "domain": "t-mobile.com",
                "ads": 2623,
                "all": 3916,
                "common": 452
            }
        ],
        "summary_info": {
            "page": 1,
            "left_lines": 997925
        }
    }
}