Отримання списку регіонів проєкту та їхнього статусу
Метод RtApiSearchEngineProcedure.getProjectRegions повертає список регіонів проєкту та їхній статус.
Приклад використання: Отримайте список регіонів для кожного проєкту в Моніторингу з їх статусом, щоб перевірити, як відстежуються позиції сайту в різних регіонах та забезпечити точність аналізу на всіх цільових ринках.
1. Надішліть запит, використовуючи метод RtApiSearchEngineProcedure.getProjectRegions з ID проєкту.
2. Отримайте список регіонів разом зі статусами Моніторингу для кожного з них.
3. Проаналізуйте отримані дані та прийміть рішення щодо подальших дій (оновлення регіонів, додавання
нових, оновлення позицій).
Загальні параметри запиту та інструкція щодо використання Serpstat API
Доступні пошукові бази
Параметри запиту | |||||
Параметри | Опис | Тип | Обов'язковий | Значення за замовчуванням | Варіанти значень |
id | Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор. | int/string | ні | Будь-яке числове або текстове значення. Наприклад: 1, test, хаймарс | |
method | Назва методу API | string | ні | RtApiProjectProcedure.getProjects | |
params | Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...] | ні | |||
projectId | Ідентифікатор проєкту | int | ні | Числове значення |
Параметри відповіді | |
Параметр | Опис |
id | Ідентифікатор відповіді: відповідає id в запиті |
result | Містить в собі відповідь |
projectId | Iдентифікатор проєкту |
regions | Масив регіонів |
id | Ідентифікатор регіону |
active | Статус регіону: * true — активний; *false — деактивований |
serpType | Тип видачі: * organic — органічна; * paid — платна |
deviceType | Тип пристрою: * desktop — комп'ютер; * mobile — телефон |
searchEngine | Тип пошукової системи: |
country | Країна видачі |
region | Регіон видачі |
city | Мiсто видачі |
langCode | Код мови |
За цим методом ліміти API не списуються.
{
"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
}
}