Сохранение настроек Аудита
Метод AuditSite.setSettings сохраняет массив настроек по указанному проекту.
Пример использования: С помощью метода AudiSite.setSettings можно вносить изменения в настройки проектов, не открывая веб-браузер.
Общие параметры запроса и инструкция по использованию Serpstat API.
Параметры запроса | |
Параметр | Описание |
id | Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения. |
method | Название метода API: AuditSite.setSettings |
params | Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]. |
projectId | Идентификатор проекта в модуле аудита. Можно взять из URL в интерфейсе настроек выбранного проекта (пример на скриншоте выше) |
domain | Домен проекта |
name | Название проекта |
subdomainsCheck | Учитывать ли поддомены |
pagesLimit | Лимит страниц сканирования |
scanSpeed | Скорость сканирования |
autoSpeed | Автоматический контроль скорости |
autoUserAgent | Автоматическая смена User Agent при неудачном ответе сервера |
scanNoIndex | Сканировать страницы закрытые от индексации |
scanWrongCanonical | Сканировать неканоничные страницы |
scanDuration | Продолжительность сканирования |
folderDepth | Глубина директорий сканирования |
urlDepth | Глубина переходов |
userAgent | User Agent |
robotsTxt | Учитывать ли инструкции robots.txt |
withImages | Проверять изображения |
dontScanKeywordsBlock | Не сканировать страницы с указанными ключевыми фразами в URL |
onlyScanKeywordsBlock | Сканировать страницы с указанными ключевыми фразами в URL |
baseAuthBlock | Доступ к сайтам, закрытым через BaseAuth |
login | Логин для BaseAuth |
password | Пароль для BaseAuth |
mailTriggerSettings | Настройки для триггерной рассылки |
emails | Массив email, на которые отправляется триггерная рассылка |
interval | Частота отправки триггерных рассылок |
enabled | Включена ли триггерная рассылка |
scheduleSettings | Настройки расписания сканирования |
scheduleRepeatOption | Идентификатор частоты сканирования |
scanSetting | Настройки типа сканирования |
type | Идентификатор типа режима сканирования |
list | Массив с URL, который нужно просканировать |
importedFilename | Название файла, для импортированных ранее URL |
Параметры ответа | |
Параметр | Описание |
id | Идентификатор запроса: соответствует id в запросе |
result | Содержит ответ |
Лимиты за этот метод не списываются.
{
"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"
}
}
}
{
"id": "1",
"result": null
}