Stopping running audit
AuditSite.stop — this method stops a running audit.
Use case: With the AuditSite.stop method, stop any running Audit project at any time.
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.stop |
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 | 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.
{
"id":1,
"method": "AuditSite.stop",
"params":{
"projectId":123456
}
}
{
"id": "1",
"result": true
}
Exception if a project has no Audit:
{
"id": "1",
"error": {
"code": -32085,
"message": "No reports.",
"data": {}
}
}