Зупинка запущеного аудиту
Метод AuditSite.stop зупиняє запущений аудит.
Приклад використання: За допомогою методу AuditSite.stop зупиніть процес аудиту без відкриття веб-інтерфейсу.
Загальні параметри запиту та інструкція щодо використання Serpstat API.
Параметр | Опис | Тип даних | Опціональний | Значення за замовчуванням | Варіанти значень |
id | Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор. | int/string | ні |
| Текстовое или числовое значение |
method | Назва методу API | string | ні |
| AuditSite.stop |
params | Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...] | ні |
|
| |
projectId | Ідентифікатор проекту аудиту | int | ні | 1251109 (ID номер потрібного проєкту) |
Параметри відповіді | |
Параметр | Опис |
id | Ідентифікатор відповіді: відповідає id в запиті |
result | Містить відповідь (true-аудит зупинений; false-аудит не був запущений) |
error | {...} Масив з параметрами помилки |
code | Код помилки |
message | Текст помилки |
data | Дані помилки |
Ліміти за цей метод не списуються.
{
"id":1,
"method": "AuditSite.stop",
"params":{
"projectId":123456
}
}
{
"id": "1",
"result": true
}
Exception, якщо у проекта немає Аудитів:
{
"id": "1",
"error": {
"code": -32085,
"message": "No reports.",
"data": {}
}
}