Сохранение настроек Аудита

Метод AuditSite.setSettings сохраняет массив настроек по указанному проекту.

Пример использования: С помощью метода AudiSite.setSettings можно вносить изменения в настройки проектов, не открывая веб-браузер.

Общие параметры запроса и инструкция по использованию Serpstat API.

Параметры запроса
Параметр	Описание	Тип данных	Обязательный	Значение по умолчанию	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения	int/string	да		Текстовое или числовое значение
method	Название метода АРI	string	да		AudiSite.setSettings
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]		да
projectId	Идентификатор проекта в модуле аудита. Можно взять из URL в интерфейсе настроек выбранного проекта	int	да		1251109 (any project ID number)
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
}