Отримання списку топ-20 доменів за фразами проекту (getTopCompetitorsDomainsHistory)
Метод getTopCompetitorsDomainsHistory повертає список доменів, що потрапили у топ-20 пошукової видачi у регіонi мінімум за двома фразами проєкту. Аналогічний до звіту Моніторинг позицій — Конкуренти.
Загальні параметри запиту та інструкція щодо використання Serpstat API
| Параметри запиту | |||
| Параметр | Значення | Опис | |
| id | обов'язково | any number or string | Ідентифікатор запиту |
| method | обов'язково | RtApiSerpResultsProcedure.getTopCompetitorsDomainsHistory | Назва методу API |
| params | обов'язково | {...} | Об'єкт з параметрами |
| projectId | обов'язково | number |
Ідентифiкатор проєкту
|
| projectRegionId | обов'язково | number |
Ідентифікатор регіону
|
| page | обов'язково | number |
Номер сторінки. За замовчуванням — 1
|
| pageSize | опціонально | number (20,50,100,200,500) | Кількість результатів на сторінці. За замовчуванням — 100 |
| dateFrom | опціонально | date (yyyy-mm-dd) |
Дата початку періоду, за який необхідно отримати дані. За замовчуванням — 30 днів від останнього зняття позицій.
|
| dateTo | опціонально | date (yyyy-mm-dd) |
Дата кінця періоду, за який необхідно отримати данi. За замовчуванням — дата останнього зняття позицій.
|
| sort | опціонально | string: *sum_traffic — розподіл трафіку; * keywords_count — кількість ключових фраз; * avg_position — середня позиція; * position_ranges — діапазони розподілу позицій; * ads_count — кількість платних об'яв |
Параметр, за яким буде проходити сортування. За замовчуванням — за розподілом трафіку. |
| sortRange | опціонально | string: *top1\top2... — розподіл по позиціях; * keywords_count_bottom\keywords_count_top\ — розподіл по рекламних блоках; * avg_position_top\avg_position_bottom\ — середня позиція у рекламному блоці |
Використовується при сортуванні за параметром position_ranges.
|
| order | опціонально | string: * asc — за зростанням; * desc — за спаданням |
Напрям сортування. За замовчуванням — за зменшенням. |
| domains | опціонально | array: ["domain1.com", "domain2.com"] | Домени, для яких потрібно отримати дані. За замовчуванням: всі домени, що потрапили у топ-20 хоча б по 2 фразах проєкту. |
| Параметри відповіді | |
| Параметр | Опис |
| id | Ідентифікатор відповіді: відповідає id в запиті |
| result | Містить в собі відповідь |
| data | Об'єкт з даними |
| projectId | Ідентифікатор проєкту |
| projectRegionId | Ідентифікатор регіону |
| competitors | Масив з доменами |
| domain | Домен, що потрапив у топ-20 хоча б за двома фразами проєкту |
| 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, та 21-50 в Yandex |
| Регіони з контекстом | |
| ads_count | Кількість оголошень домену, які були виявлені в контексті |
| keywords_count_blocks | Розподіл ключових фраз у блоках контексту |
| avg_position_blocks | Середня позиція у блоках контексту |
| top | Верхній блок реклами |
| sidebar | Бічний блок реклами |
| bottom | Нижній блок реклами |
| summary info | Блок зведеної інформації |
| page | Поточна сторінка |
| page_total | Кількість сторінок з результатами при обраному параметрі pageSize |
| count | Кількість результатів на сторінку |
| total | Загальна кількість результатів |
| sort | Сортування за параметрами |
| order | Напрям сортування |
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
}
}