Obtaining the list of domains from top 20 project keywords (getTopCompetitorsDomainsHistory)
getTopCompetitorsDomainsHistory method returns the list of domains by project region, which were listed in the top 20 for two any project keywords.
| Request parameters | ||
| Parameter | Value | Description |
| id | any number or string | Request ID |
| method | RtApiSerpResultsProcedure.getTopCompetitorsDomainsHistory | API method name |
| params | {...} | Array of parameters |
| projectId | number |
Project ID
|
| projectRegionId | number |
Region ID
|
| page | number |
Page number. 1 by default
|
| pageSize (optional) | number (20,50,100,200,500) | Number of search results on the page. 100 by default. |
| dateFrom (optional) | date (yyyy-mm-dd) |
Start date of period for which the data is required. 30 days by default, from the last position withdrawal.
|
| dateTo (optional) | date (yyyy-mm-dd) |
End date of the period for which the data is required
|
| sort (optional) | string (sum_traffic — traffic distribution, keywords_count — number of keywords, avg_position — average position, position_ranges — position distribution ranges, ads_count — number of ads) |
Parameter used for sorting. Traffic distribution by default. |
| sortRange (optional) | string
(top1\top2... — position distribution by position keywords_count_bottom\keywords_count_top\ — distribution by ads avg_position_top\avg_position_bottom\ — average position by ads) |
Used for sorting *position_ranges*.
|
| order (optional) | string (desc | asc) | Sorting order. Descending by default |
| domains (optional) | domain | Domain used for data. Data obtained by all domains in top 20 for two project keywords by default. |
| Response parameters | |
| Parameter | Description |
| id | Request ID |
| result | Contains the answer |
| projectId | Project ID |
| projectRegionId | Region ID |
| competitors | Array of domains |
| domain |
Domain appeared in top 20 by two project keyword |
| dates | Array of dates with data for the specified domain |
| date | Date for which the data on the domain is displayed |
| value | Parameter value |
| traffic_distribution | Domain traffic distribution among all domains in top 20 |
| avg_position | Domain average position among the best positions for project keywords |
| keywords_count | Number of keywords for which the domain got into search results |
| keywords_by_ranges | Keywords distribution by domain position range |
| top1 | Keywords for which the domain took the 1 position |
| top3 |
Keywords for which the domain took the 2-3 position |
| top5 | Keywords for which the domain took the 4-5 position |
| top10 | Keywords for which the domain took the 6-10 position |
| top20 | Keywords for which the domain took the 11-20 position |
| top101 | Keywords for which the domain took the 21-100 position in Google and 21-50 position in Yandex |
| Regions with PPC | |
| ads_count | Number of ads for which domain appeared in PPC |
| keywords_count_blocks | Keywords distribution by PPC blocks |
| avg_position_blocks | Average position distribution by PPC blocks |
| top | Top ad block |
| sidebar | Side ad block |
| bottom | Bottom ad block |
| summary info | Summary data block |
| page | Current page |
| page_total | Number of pages with the results for the selected parameter page size |
| count | Number of results per page |
| total | Total number of results |
| sort | Sorting by parameters |
| order | Sorting order |
Request data:
{
"id": "1",
"method": "RtApiSerpResultsProcedure.getTopCompetitorsDomainsHistory",
"params": {
"projectId": 651696,
"projectRegionId": 249084,
"page": 1,
"pageSize": 20,
"dateFrom": "2020-08-27",
"dateTo": "2020-08-28",
"sort": "domain",
"order": "asc",
"domains": [
"fursk.ru",
"ozon.ru"
]
}
}
Response data:
Органические регионы
{
"id": "1",
"result": {
"projectId": 651696,
"projectRegionId": 249084,
"competitors": [
{
"domain": "fursk.ru",
"dates": [
{
"date": "2020-08-28",
"result": {
"traffic_distribution": {
"value": 55.37
},
"avg_position": {
"value": 31.3
},
"keywords_count": {
"value": 5971
},
"keywords_by_ranges": {
"top1": {
"value": 148
},
"top3": {
"value": 215
},
"top5": {
"value": 276
},
"top10": {
"value": 803
},
"top20": {
"value": 1321
},
"top101": {
"value": 3208
}
}
}
}
]
},
"summary_info": {
"page": 1,
"page_total" : 150,
"count" : 100,
"total": 100,
"sort": null,
"order": null
}
}
}
Контекстные регионы
{
"id": "1",
"result": {
"projectId": 715910,
"projectRegionId": 262190,
"competitors": [
{
"domain": "rozetka.com.ua",
"dates": [
{
"date": "2020-07-08",
"result": {
"keywords_count": {
"value": 1
},
"ads_count": {
"value": 1
},
"keywords_count_blocks": {
"top": {
"value": 1
},
"sidebar": {
"value": 0
},
"bottom": {
"value": 0
}
},
"avg_position_blocks": {
"top": {
"value": 1
},
"sidebar": {
"value": 0
},
"bottom": {
"value": 0
}
}
}
},
"summary_info": {
"page": 1,
"page_total" : 150,
"count" : 100,
"total": 100,
"sort": null,
"order": null
}
}
}