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:

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

Поделитесь статьей с вашими друзьями

Are you sure?

Персональная презентация сервиса

Serpstat is all about saving time, and we want to save yours! One of our specialists will contact you and discuss options going forward.

These may include a personal demonstration, a trial period, comprehensive training articles & webinar recordings, and custom advice from a Serpstat specialist. It is our goal to make you feel comfortable while using Serpstat.

Name

Email

Phone

We are glad of your comment
Política de privacidad.

Спасибо, мы с вами свяжемся в ближайшее время

Open support chat