Stopping running audit

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:

 "method": "AuditSite.stop",


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

Exception if a project has no Audit:

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

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.




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