Obtaining the list of project regions and their status
The getProjectRegions method returns the list of project regions and their status.
General request parameters and instructions for using Serpstat API
Request parameters | |||
Parameter | Value | Description | |
id | required | any number or string | Request ID |
method | required | RtApiSearchEngineProcedure.getProjectRegions | API method name |
params | required | {...} | Object with parameters |
projectId | required | number |
Project ID
|
Response parameters | |
Parameter | Description |
id | Response id corresponds the request id |
result | Contains the answer |
projectId | Project ID |
regions | Array with regions |
id | Region ID |
active |
Region status:
* true — active; * false — deactivated |
serpType | SERP type: * organic * paid (PPC) |
deviceType | Device type: * desktop * mobile |
searchEngine | Search engine type: * Yandex |
country | Search results country |
region | Search results region |
city | Search results city |
langCode | Language code |
This method doesn't require API credits.
{
"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
}
}