Получение списка доменов из топ-20 по ключевым фразам проекта

Метод RtApiSerpResultsProcedure.getTopCompetitorsDomainsHistory возвращает список доменов по региону проекта, которые попали в топ-20 минимум по 2 любым ключевым фразам проекта. Аналогичен отчету Мониторинг позиций — Конкуренты.

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

Параметры запроса
Параметр	Описание	Тип	Опциональный	Значение по умолчанию	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор.	int / string	нет		Любое текстовое или числовое значение. Например: 1, test, тест
method	Название метода API	string	нет		RtApiSerpResultsProcedure.getTopCompetitorsDomainsHistory
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]		нет
projectId	Идентификатор проекта	int	нет		Числовое значение идентификатора проекта
projectRegionId	Идентификатор региона	int	нет		Числовое значение идентификатора региона
page	Номер страницы	int	нет	1	Числовое значение.
pageSize	Количество результатов на странице	int	да	100	Числовое значение. Возможные варианты значений: 20, 50, 100, 200, 500
dateFrom	Дата начала периода, по которому нужны данные	date	да	30 дней с момента последнего снятия позиций	Числовое значение, формат данных: yyyy-mm-dd
dateTo	Дата конца периода, по которому нужны данные	date	да	Дата последнего снятия позиций	Числовое значение, формат данных: yyyy-mm-dd
sort	Сортировка по параметрам	string	да	traffic	Возможные значения: "sum_traffic" — по распределению трафика, "keywords_count" — по количеству ключевых фраз, "avg_position" — по средней позиции, "position_ranges" — по топам распределения позиций, "ads_count" — по количеству платных объявлений
sortRange	Используется при сортировке по position_ranges	string	да		Возможные значения: "top1\top2"... — распределение по позициям, "keywords_count_bottom\keywords_count_top" — распределение по рекламным блокам, "avg_position_top\avg_position_bottom" — средняя позиция по рекламным блокам
order	Направление сортировки	string	да	desc	desc — по убыванию, asc — по возрастанию
domain	Домен/домены по которым нужны данные	array	да	Все домены, что попали в топ-20 хотя бы по 2 фразам проекта	Текстовое значение. Формат данных: ["domain1.com", "domain2.com"]

Параметр ответа
Параметр	Описание
id	Идентификатор запроса: соответствует id в запросе
result	Содержит в себе ответ
data	Объект с данными
projectId	Идентификатор проекта
projectRegionId	Идентификатор региона
competitors	Массив с доменами
domain	Домен, который встретился в выдаче топ-20, минимум по 2 ключевым фразам проекта
dates	Массив дат с данными по указанному домену
date	Дата, за которую выводятся данные по домену
value	Значение параметра
traffic_distribution	Распределение трафика домена среди всех доменов в топ-20
avg_position	Средняя позиция домена среди лучших позиций по ключевым фразам проекта
keywords_count	Количество ключевых фраз, по которым домен попал в выдачу
keywords_by_ranges	Распределение ключевых фраз по диапазонам позиций домена
top1	Ключевые фразы, где домен занял 1 позицию
top3	Ключевые фразы, где домен занял 2-3 позицию
top5	Ключевые фразы, где домен занял 4-5 позицию
top10	Ключевые фразы, где домен занял 6-10 позицию
top20	Ключевые фразы, где домен занял 11-20 позицию
top101	Ключевые фразы, где домен занял 21-100 позицию в Google
	Регионы с контекстом
ads_count	Количество объявлений домена, которые встретились в контексте
keywords_count_blocks	Распределение ключевых фраз по блокам контекста
avg_position_blocks	Распределение средних позиций по блокам контекста
top	Верхний блок рекламы
sidebar	Боковой блок рекламы
bottom	Нижний блок рекламы
summary info	Блок сводной информации
page	Текущая страница
page_total	Количество страниц с результатами при выбранном параметре pageSize
count	Количество результатов на страницу
total	Общее количество результатов
sort	Сортировка по параметрам
order	Направление сортировки

Возможные ошибки в ответе
Код ошибки	Описание
-32009\-32602	Невалидные параметры запроса. Описание какие параметры и в чем проблема
-33054	Проект удален
-34001	Неправильный projectRegionId для проекта
-34002	Диапазон дат должен содержать менее 30 дат анализа
-32002	Пустой результат
-34004	На данной странице нет результатов

По этому методу лимиты не списываются.

Example

Request data:

{
    "id": "1",
    "method": "RtApiSerpResultsProcedure.getTopCompetitorsDomainsHistory",
   "params": {
        "projectId": 853932,
        "projectRegionId": 293402,
        "page": 1,
        "pageSize": 20,
        "dateFrom": "2021-07-26",
        "dateTo": "2021-07-27",
        "sort": "domain",
        "order": "asc",
        "domains": [
            "adidas.com",
            "nike.com"
        ]  
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": {
            "projectId": 853932,
            "projectRegionId": 293402,
            "competitors": [
                {
                    "domain": "adidas.com",
                    "dates": [
                        {
                            "date": "2021-07-26",
                            "result": {
                                "traffic_distribution": {
                                    "value": 19.390000000000001
                                },
                                "avg_position": {
                                    "value": 2.7000000000000002
                                },
                                "keywords_count": {
                                    "value": 12
                                },
                                "keywords_by_ranges": {
                                    "top1": {
                                        "value": 5
                                    },
                                    "top3": {
                                        "value": 3
                                    },
                                    "top5": {
                                        "value": 3
                                    },
                                    "top10": {
                                        "value": 1
                                    },
                                    "top20": {
                                        "value": 0
                                    },
                                    "top101": {
                                        "value": 0
                                    }
                                }
                            }
                        },
                        {
                            "date": "2021-07-27",
                            "result": {
                                "traffic_distribution": {
                                    "value": 17.25
                                },
                                "avg_position": {
                                    "value": 3.1000000000000001
                                },
                                "keywords_count": {
                                    "value": 12
                                },
                                "keywords_by_ranges": {
                                    "top1": {
                                        "value": 6
                                    },
                                    "top3": {
                                        "value": 2
                                    },
                                    "top5": {
                                        "value": 2
                                    },
                                    "top10": {
                                        "value": 2
                                    },
                                    "top20": {
                                        "value": 0
                                    },
                                    "top101": {
                                        "value": 0
                                    }
                                }
                            }
                        }
                    ]
                },
                {
                    "domain": "nike.com",
                    "dates": [
                        {
                            "date": "2021-07-26",
                            "result": {
                                "traffic_distribution": {
                                    "value": 7.6299999999999999
                                },
                                "avg_position": {
                                    "value": 15.1
                                },
                                "keywords_count": {
                                    "value": 9
                                },
                                "keywords_by_ranges": {
                                    "top1": {
                                        "value": 0
                                    },
                                    "top3": {
                                        "value": 2
                                    },
                                    "top5": {
                                        "value": 1
                                    },
                                    "top10": {
                                        "value": 3
                                    },
                                    "top20": {
                                        "value": 2
                                    },
                                    "top101": {
                                        "value": 1
                                    }
                                }
                            }
                        },
                        {
                            "date": "2021-07-27",
                            "result": {
                                "traffic_distribution": {
                                    "value": 7.6799999999999997
                                },
                                "avg_position": {
                                    "value": 14.6
                                },
                                "keywords_count": {
                                    "value": 9
                                },
                                "keywords_by_ranges": {
                                    "top1": {
                                        "value": 0
                                    },
                                    "top3": {
                                        "value": 2
                                    },
                                    "top5": {
                                        "value": 1
                                    },
                                    "top10": {
                                        "value": 3
                                    },
                                    "top20": {
                                        "value": 2
                                    },
                                    "top101": {
                                        "value": 1
                                    }
                                }
                            }
                        }
                    ]
                }
            ]
        },
        "summary_info": {
            "page": 1,
            "page_total": 1,
            "count": 20,
            "total": 2,
            "sort": "domain",
            "order": "asc"
        },
        "spent_limits": 0
    }
}