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

Audit start (AuditSite.start)

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

Request parameters
Parameters Value Description
id any number or string A request id: the response contains the same id. Enter any number (number) or text (string) value
method AuditSite.start API method name 
params {...} The object with parameters {...}, it lists all the following parameters and arrays [...]
projectId (important) Project id
Audit project id

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": null
}

Except if you already have one:
{
    "id": "1",
    "error": {
        "code": -32124,
        "message": "Can't start Audit. Already have one  ",
        "data": {
        }
    }
}