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

Stopping running audit (AuditSite.stop)

AuditSite.stop — this method stops a running audit.

 

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.stop API method name: AuditSite.stop
params {...} The object with parameters {...}, it lists all the following parameters and arrays [...]
projectId (обязательный) Project id
Audit project id

Response parameters
Parameters Description
id Response id corresponds the request id
result Contains the response (true-audit was stopped; false-audit was not started)
error {...} Array of error parameters
code Error code
message Error message
data Error data

Credits for this method are not deducted.

Example PHP Python
Request data:

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

  }

}
Response data:
{
    "id": "1",
    "result": true
}

Exception if a project has no Audit:

{
    "id": "1",
    "error": {
        "code": -32085,
        "message": "No reports.",
        "data": {}
    }
}