Значення налаштувань проекту за замовчуванням
Метод AuditSite.getDefaultSettings повертає список дефолтних значень з налаштування проекту.
Приклад використання: за допомогою методу AuditSite.getDefaultSettings перевірте налаштування проєкту за замовчуванням.
Загальні параметри запиту та інструкція щодо використання Serpstat API.
| Параметри запиту | |||||
| Параметр | Опис | Тип даних | Опціональний | Значення за замовчуванням | Варіанти значень |
| id | Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор. | int/string | нет |
| будь-яке текстове або числове значення |
| method | Назва методу API | string | нет |
| AudiSite.setSettings |
| params | Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...] | нет |
|
| |
| Параметри відповіді | |
| Параметр | Опис |
| id | Ідентифікатор відповіді: відповідає id в запиті |
| result | Містить в собі відповідь |
| domain | Домен проекту |
| name | Назва проекту |
| subdomainsCheck | Чи враховувати піддомени |
| pagesLimit | Ліміт сторінок сканування |
| scanSpeed | Швидкість сканування |
| autoSpeed | Автоматичний контроль швидкості |
| autoUserAgent | Автоматична зміна User Agent при невдалій відповіді серверу |
| scanNoIndex | Сканувати сторінки закриті від індексації |
| scanWrongCanonical | Сканувати неканонічні сторінки |
| scanDuration | Тривалість сканування |
| folderDepth | Глибина директорій сканування |
| urlDepth | Глибина переходів |
| userAgent | User Agent |
| robotsTxt | Чи враховувати інструкції robots.txt |
| 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 | |
| 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
}
}
}