Get access to 30+ marketing and SEO tools. analyze competitors, keywords, and backlinks for free..
Sign in Sign Up

We use cookies to make Serpstat better. By clicking "Accept cookies", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. Learn more

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

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

This method doesn't require API credits.

If you'd like to get advice on Serpstat's features, order youfree 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
    }
}