Отримання списку регіонів проєкту та їх статусу (getProjectRegions)
Метод getProjectRegions повертає список регіонів проєкту та їх статус.
Загальні параметри запиту та інструкція щодо використання Serpstat API
| Параметри запиту | |||
| Параметр | Значення | Опис | |
| id | обов'язково | any number or string | Ідентифікатор запиту |
| method | обов'язково | RtApiSearchEngineProcedure.getProjectRegions | Назва методу API |
| params | обов'язково | {...} | Об'єкт з параметрами |
| projectId | обов'язково | number |
Ідентифікатор проєкту
|
| Параметри відповіді | |
| Параметр | Опис |
| id | Ідентифікатор відповіді: відповідає id в запиті |
| result | Містить в собі відповідь |
| projectId | Iдентифікатор проєкту |
| regions | Масив регіонів |
| id |
Ідентифікатор регіону
|
| active |
Статус регіону:
* true — активний; *false — деактивований |
| serpType | Тип видачі: * organic — органічна; * paid — платна |
| deviceType | Тип пристрою: * desktop — комп'ютер; * mobile — телефон |
| searchEngine | Тип пошукової системи: * Google; * Yandex |
| country | Країна видачі |
| region | Регіон видачі |
| city | Мiсто видачі |
| langCode | Код мови |
За цим методом ліміти API не списуються.
Якщо вам потрібна консультація про можливості Serpstat для ваших задач, замовте безкоштовну 30-хвилинну демонстрацію.
Залишилися питання? Зверніться в чат техпідтримки.
Request data:
{
"id": 1,
"method": "RtApiSearchEngineProcedure.getProjectRegions",
"params": {
"projectId": 853932
}
}Response data:
{
"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
}
}