Obtaining the project's status

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

Use case:
1. To check whether automatic positions tracking is active for a specific project.
2. To check project's automatic positions tracking status in case of decrease/increase of the plan.
3. The leader of the team can check the automatic positions tracking status of the projects, which are either his
own or the projects of his team members.

General request parameters and instructions for using Serpstat API

Search databases available

Request parameters
Parameter	Description	Type	Required	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 If "regionId" is not specified in the request, the system looks at all regions of the project, and if automatic positions tracking is activated in at least one of them, it returns the value "true" for this 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
    }
}