Збереження налаштувань Аудиту

Метод AuditSite.setSettings зберігає масив налаштувань щодо зазначеного проекту.

Приклад використання: За допомогою методу AudiSite.setSettings ви можете додавати зміни до налаштувань проекту, не відкриваючи веб-браузер.

Загальні параметри запиту та інструкція щодо використання Serpstat API.

Параметри запиту
Параметр	Опис	Тип даних	Обов'язковий	Значення за замовчуванням	Варіанти значень
id	Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор.	int/string	так		будь-яке текстове або числове значення
method	Назва методу API	string	так		AudiSite.setSettings
params	Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...]		так
projectId	Ідентифікатор проекту аудиту	int	так		1251109 (ID номер потрібного проєкту)
domain	Ідентифікатор проекту аудиту	string	так		lush.com
name	Назва проєкту	string	так		lush.com
subdomainsCheck	Чи враховувати піддомени	boolean	так		true, false
pagesLimit	Ліміт сторінок сканування	int	так		числове значення, мін - 0; макс - ліміти вашого плану
scanSpeed	Швидкість сканування	int	так		числове значення, мін - 1; макс - 30
autoSpeed	Автоматичний контроль швидкості	boolean	так		true, false
autoUserAgent	Автоматична зміна User Agent у разі невдалої відповіді сервера	boolean	так		true, false
scannoIndex	Сканувати сторінки закриті від індексації	boolean	так		true - Аудит проводиться з урахуванням сторінок ні_index false - Аудит проводиться без урахування сторінок ні_index
scanWrongCanonical	Сканувати неканонічні сторінки	boolean	так		true - Аудит проводиться з урахуванням неканонічних сторінок false - Аудит проводиться без урахування неканонічних сторінок
scanDuration	Тривалість сканування	int	так		від 0 до 999999
folderDepth	Глибина директорій сканування	int	так		від 0 до 999999
urlDepth	Глибина переходів	int	так		від 0 до 999999
userAgent	Вибір User Agent для аудиту	int	так		0 - Chrome 1 - Serpstatbot 2 - Google 4 - Firefox 5 - IE
robotsTxt	Чи враховувати інструкції robots.txt	boolean	так		true, false
withImages	Перевіряти зображення	boolean	так		true, false
dontScanKeywordsBlock	Не сканувати сторінки із зазначеними ключовими фразами в адресах цих сторінок		так
checked	чи повинен Аудит сканувати за такими ключовими фразами чи ні	boolean	так		true - якщо такі фрази false - якщо таких фраз немає
keywords	ключові фрази, які Аудит має враховувати	string	так		текст, залиште "", якщо таких ключових фраз немає
onlyScanKeywordsBlock	Сканувати сторінки із зазначеними ключовими фразами в адресах цих сторінок		так
checked	чи повинен Аудит сканувати за такими ключовими фразами чи ні	boolean	так		true - якщо такі ключові фрази є false - якщо таких ключових фраз немає
keywords	ключові фрази, які Аудит має враховувати	string	так		текст, залиште "", якщо таких ключових фраз немає
baseAuthBlock	Доступ до сайтів, закритих через BaseAuth		так
login	Логін для BaseAuth	string	так		текст або цифри, "12345" "somelogin"
password	Пароль для BaseAuth	string	так		текст або цифри, "12345" "somepassword"
mailTriggerSettings	Налаштування для тригерної розсилки		так
emails	Масив email, на які надсилається тригерна розсилка	string[]	так		test@gmail.com
interval	Частота надсилання повідомлень	int	так		0 - вручну; 1 - щодня; 2 - кожні 3 дні; 3 - раз на тиждень; 4 - раз на два тижні; 5 - раз на місяць;
enabled	Чи ввімкнено тригерну розсилку	boolean	так		true, false
scheduleSettings	Налаштування розкладу сканування		так
scheduleRepeatOption	Ідентифікатор частоти сканування	int	так		0 - вручну; 1 - щодня; 2 - кожні 3 дні; 3 - раз на тиждень; 4 - раз на два тижні; 5 - раз на місяць;
scanSetting	Настройки типа сканирования		так
type	Ідентифікатор типу режиму сканування	int	так		1 - вручну; 2 - за списком URL; 3 - за картою сайту;
list	Масив з URL, який потрібно просканувати	string[]	так		"https://makeup.com.ua/ua/", "https://makeup.com.ua/ua/categorys/3/"
importedFilename	Назва файлу, для імпортованих раніше URL	string\|null	так		назва відповідного файлу

Параметри відповіді
Параметр	Опис
id	Ідентифікатор відповіді: відповідає id в запиті
result	Містить в собі відповідь

Ліміти за цей метод не списуються.

Example

Request data:

{
 "id":1,
 "method": "AuditSite.setSettings",
 "params":{
  "projectId":123456,
     "mainSettings": {
        "domain": "lush.com",
        "name": "lush.com",
        "subdomainsCheck": true,
        "pagesLimit": 5321,
        "scanSpeed": 1,
        "autoSpeed" : true,
        "autoUserAgent": true,
        "scanNoIndex":false,
        "scanWrongCanonical":true,
        "scanDuration": 0,
        "folderDepth": 0,
        "urlDepth": 0,
        "userAgent": 0,
        "robotsTxt": true,
        "withImages": true
    },
    "dontScanKeywordsBlock": {
        "checked": true,
        "keywords": "text1"
    },
    "onlyScanKeywordsBlock": {
        "checked": true,
        "keywords": "text2"
    },
    "baseAuthBlock": {
        "login": "222",
        "password": "444"
    },
    "mailTriggerSettings": {
        "emails": [],
        "interval": 1,
        "enabled": false
    },
    "scheduleSettings": {
        "scheduleRepeatOption": 3
    },
    "scanSetting": {
        "type": 2,
        "list": [],
        "importedFilename":"xxx.xxx"
    }
  }

}

Response data:

{
    "id": "1",
    "result": null
}