Значения настроек проекта по умолчанию
Метод AuditSite.getDefaultSettings возвращает список дефолтных значений по настройкам проекта.
Пример использования: с помощью метода AuditSite.getDefaultSettings проверьте настройки проекта по умолчанию.
Общие параметры запроса и инструкция по использованию Serpstat API.
| Параметры запроса | |||||
| Параметр | Описание | Тип данных | Опциональный | Значение по умолчанию | Варианты значений |
| id | Идентификатор запроса: ответ содержит этот же идентификатор. Ввод числового (number) или текстового (string) значения. | int/string | нет |
| 1, test |
| method | Название метода API | string | нет |
| AuditSite.getDefaultSettings |
| params | Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...] | нет | {...} / [...] | ||
| Параметры ответа | |
| Параметр | Описание |
| id | Идентификатор запроса: соответствует id в запросе |
| result | Содержит ответ |
| domain | Домен проекта |
| name | Название проекта |
| subdomainsCheck | Учитывать ли поддомены |
| pagesLimit | Лимит страниц сканирования |
| scanSpeed | Скорость сканирования |
| autoSpeed | Автоматический контроль скорости |
| autoUserAgent | Автоматическая смена User Agent при неудачном ответе сервера |
| scanNoIndex | Сканировать страницы закрытые от индексации |
| scanWrongCanonical | Сканировать неканоничные страницы |
| scanDuration | Продолжительность сканирования |
| folderDepth | Глубина директорий сканирования |
| urlDepth | Глубина переходов |
| userAgent | User Agent |
| robotsTxt | Учитывать ли инструкции robots.txt |
| withImages | Сканирование с (true) или без (false) картинок |
| dontScanKeywordsBlock | Не сканировать страницы с указанными ключевыми фразами в URL |
| onlyScanKeywordsBlock | Сканировать страницы с указанными ключевыми фразами в URL |
| baseAuthBlock | Доступ к сайтам, закрытым через BaseAuth |
| login | Логин для BaseAuth |
| password | Пароль для BaseAuth |
| mailTriggerSettings | Настройки для триггерной рассылки |
| emails | Массив email, на которые отправляется триггерная рассылка |
| interval | Частота отправки триггерных рассылок |
| enabled | Включена ли триггерная рассылка |
| scheduleSettings | Настройки расписания сканирования |
| scheduleRepeatOption | Идентификатор частоты сканирования |
| scanSetting | Настройки типа сканирования |
| type | Идентификатор типа режима сканирования |
| list | Массив с URL, который нужно просканировать |
| importedFilename | Название файла, для импортированных ранее URL |
| errorsSettings | Другие настройки |
| tiny_title | Минимальное количество символов в title |
| long_title | Максимальное количество символов в title |
| tiny_desc | Минимальное количество символов в description |
| long_desc | Максимальное количество символов в description |
| long_url | Максимальная длина url |
| large_image_size | Слишком большие изображения |
| large_page_size | |
| many_external_links | |
Лимиты за этот метод не списываются.
Request data:
{
"id":1,
"method": "AuditSite.getDefaultSettings",
"params":{}
}Response data:
{
"id": "1",
"result": {
"mainSettings": {
"domain": "",
"name": "",
"subdomainsCheck": true,
"pagesLimit": 5000,
"scanSpeed": 3,
"autoSpeed": true,
"scanNoIndex": false,
"scanWrongCanonical": true,
"autoUserAgent": true,
"scanDuration": 6,
"folderDepth": 0,
"urlDepth": 10,
"userAgent": 0,
"robotsTxt": true,
"withImages": true
},
"dontScanKeywordsBlock": {
"checked": false,
"keywords": ""
},
"onlyScanKeywordsBlock": {
"checked": false,
"keywords": ""
},
"baseAuthBlock": {
"login": "",
"password": ""
},
"mailTriggerSettings": {
"emails": [],
"interval": 7,
"enabled": true,
"enableExportAfterFinish": true
},
"scheduleSettings": {
"scheduleRepeatOption": 3
},
"scanSetting": {
"type": 1,
"list": []
},
"errorsSettings": {
"tiny_title": 10,
"long_title": 70,
"tiny_desc": 100,
"long_desc": 160,
"long_url": 1024,
"large_image_size": 100,
"large_page_size": 2,
"many_external_links": 500
}
}
}