Получение списка регионов проекта и их статуса
Метод RtApiSearchEngineProcedure.getProjectRegions возвращает список регионов проекта и их статус.
Пример использования: Получите список регионов для каждого проекта в Мониторинге с их статусом, чтобы проверить, как отслеживаются позиции сайта в разных регионах и обеспечить точность анализа на всех целевых рынках.
1. Отправьте запрос, используя метод RtApiSearchEngineProcedure.getProjectRegions с ID проекта.
2. Получите список регионов вместе со статусами Мониторинга для каждого из них.
3. Проанализируйте полученные данные и примите решение о дальнейших действиях (обновление
регионов, добавление новых, обновление позиций).
Общие параметры запроса и инструкция по использованию Serpstat API
Перечень доступных баз и стран
Параметры запроса | |||||
Параметр | Описание | Тип | Обязательный | Значение по умолчанию | Варианты значений |
id | Идентификатор запроса: ответ содержит этот же идентификатор. | int / string | нет | Любое текстовое или числовое значение. | |
method | Название метода API | string | нет | RtApiProjectProcedure.getProjects | |
params | Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...] |
| нет |
| |
projectId | Идентификатор проекта | int | нет |
| Числовое значение |
Параметры ответа | |
Параметр | Описание |
id | Идентификатор запроса: соответствует id в запросе |
result | Содержит в себе ответ |
projectId | Идентификатор проекта |
regions | Массив регионов |
id | Идентификатор региона |
active | Статус региона: * true — активный * false — деактивированный |
serpType | Тип выдачи: * organic — органическая * paid — контекстная |
deviceType | Тип устройства: * desktop — компьютер * mobile — телефон |
searchEngine | Тип поисковой системы: |
country | Страна выдачи |
region | Регион выдачи |
city | Город выдачи |
langCode | Код языка |
{
"id": 1,
"method": "RtApiSearchEngineProcedure.getProjectRegions",
"params": {
"projectId": 853932
}
}
{
"id": "1",
"result": {
"projectId": 853932,
"regions": [
{
"id": 293402,
"active": true,
"serpType": "organic",
"deviceType": "desktop",
"searchEngine": "google",
"country": "United States (USA)",
"region": "",
"city": "",
"langCode": "en"
},
{
"id": 295014,
"active": false,
"serpType": "organic",
"deviceType": "desktop",
"searchEngine": "google",
"country": "Ukraine",
"region": "",
"city": "",
"langCode": "en"
}
],
"spent_limits": 0
}
}