Audit start

AuditSite.start — method starts an audit due to the settings saved previously.

Use case: With the AuditSite.start method, start the Audit process without opening the web interface.

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		Text or number value
method	API method name	string	no		AuditSite.start
params	The object with parameters {...}, it lists all the following parameters and arrays [...]		no
projectId	Audit project id	int	no		1251109 (any project ID number)

Response parameters
Parameters	Description
id	Request id
result	Contains the answer. Null — audit start request has been completed successfully

The number of used credits = the number of pages checked.

Example

Request data:

{
    "id":1,
    "method": "AuditSite.start",
    "params":{
        "projectId":123456
    }
}

Response data:

{
    "id": "1",
    "result": {
        "reportId": 10865982
    }
}