Obtaining the list of project regions and their status (getProjectRegions)

getProjectRegions method returns the list of project regions and their status.

Request parameters
Parameter	Value	Description
id	any number or string	Request ID
method	RtApiSearchEngineProcedure.getProjectRegions	API method name
params	{...}	Array of parameters
projectId	number	Project ID

Response parameters
Parameter	Description
id	Request ID
result	Contains the answer
projectId	Project ID
regions	Array of regions
id	Region ID
active	Region status. “True” - means active, otherwise deactivated
serpType	SERP type. Organic or Paid (PPC)
deviceType	Device type. Desktop or Mobile
searchEngine	Search engine type: Google or Yandex
country	Search results country
region	Search results region
city	Search results city
langCode	Language code

Example PHP Python

Request data:

{
    "id": 1,
    "method": "RtApiSearchEngineProcedure.getProjectRegions",
    "params": {
        "projectId": 1
    }
}

Response data:

{
    "id": "1",
    "result": {
        "projectId": 1,
        "regions": [
            {
                "id": 236859,
                "active": true,
                "serpType": "organic",
                "deviceType": "desktop",
                "searchEngine": "google",
                "country": "Switzerland",
                "region": "",
                "city": "",
                "langCode": "de"
            }
        ]
    }
}