Obtaining the list of project regions and their status

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

General request parameters and instructions for using Serpstat API

Request parameters
Parameter	Description	Type	Optional	Default value	Value options
id	A request id: the response contains the same id.	int / string	no		Any text or number value, for example: 1, test
method	API method name	string	no		RtApiSearchEngineProcedure.getProjectRegions
params	The object with parameters {...}, it lists all the following parameters and arrays [...]		no
projectId	Project ID	int	no		Number value

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: * Google
country	Search results country
region	Search results region
city	Search results city
langCode	Language code

Credits for this method are not deducted.

If you'd like to get advice on Serpstat's features, order your free 30-minute demo.Still have questions? Contact the tech support chat.

Example

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
    }
}