Obtaining the project's status

The RtApiSearchEngineProcedure.getProjectStatus method returns the data of the project's status.

General request parameters and instructions for using Serpstat API
Search databases available

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

Response parameters
Parameter Description
id Response id corresponds the request id
result Contains the answer
projectId Project ID
regionID Region ID
parsing Project's automatic parsing status. true - automatic positions tracking enabled, false - automatic positions tracking disabled.

Credits for this method are not deducted.

Example
Request data:
{
    "id": 1,
    "method": "RtApiProjectProcedure.getProjectStatus",
    "params": {
        "projectId": 1127317,
        "regionId": 3245
    }
}
Response data:
{
    "id": "1",
    "result": {
        "projectId": 1127317,
        "regionId": 32423423,
        "parsing": false
    }
}

Share this article with your friends

Are you sure?

Introducing Serpstat

Find out about the main features of the service in a convenient way for you!

Please send a request, and our specialist will offer you education options: a personal demonstration, a trial period, or materials for self-study and increasing expertise — everything for a comfortable start to work with Serpstat.

Name

Email

Phone

We are glad of your comment
I agree to Serpstat`s Privacy Policy.

Thank you, we have saved your new mailing settings.

Open support chat