Налаштування проекту
Метод AuditSite.getSettings повертає список налаштувань за конкретним проектом.
Приклад використання: За допомогою методу AuditSite.getSettings перевірте налаштування проекту аудиту.
Загальні параметри запиту та інструкція щодо використання Serpstat API.
Параметри запиту | |||||
Параметр | Опис | Тип даних | Опціональний | Значення за замовчуванням | Варіанти значень |
id | Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор. | int/string | ні |
| будь-яке текстове або числове значення |
method | Назва методу API | string | ні |
| AuditSite.getSettings |
params | Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...] | ні |
|
| |
projectId | Ідентифікатор проекту аудиту | int | ні | 1251109 (ID номер потрібного проєкту) |
Параметри відповіді | |
Параметр | Опис |
id | Ідентифікатор відповіді: відповідає id в запиті |
result | Містить в собі відповідь |
domain | Домен проекту |
name | Назва проекту |
subdomainsCheck | Чи враховувати піддомени |
pagesLimit | Ліміт сторінок сканування |
scanSpeed | Швидкість сканування |
autoSpeed | Автоматичний контроль швидкості |
autoUserAgent | Автоматична зміна User Agent при невдалій відповіді серверу |
scanNoIndex | Сканувати сторінки закриті від індексації |
scanWrongCanonical | Сканувати неканонічні сторінки |
autoUserAgent | Автоматична зміна User Agent |
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 |
errorsSettings | Інші налаштування |
tiny_title | Мінімальна кількість символів в title |
long_title | Максимальна кількість символів в title |
tiny_desc | Мінімальна кількість символів в description |
long_desc | Максимальна кількість символів в description |
long_url | Занадто довгий URL |
large_image_size | Занадто великі зображення (KB) |
large_page_size | Занадто великий розмір сторінки (МВ) |
many_external_links | На сторінці занадто багато вихідних посилань |
Ліміти за цей метод не списуються.
{
"id":1,
"method": "AuditSite.getSettings",
"params":{
"projectId":123456
}
}
{
"id": "1",
"result": {
"mainSettings": {
"domain": "lush.com",
"name": "lush.com",
"subdomainsCheck": true,
"pagesLimit": 3875,
"scanSpeed": 3,
"autoSpeed": false,
"scanNoIndex": false,
"scanWrongCanonical": false,
"autoUserAgent": true,
"scanDuration": 0,
"folderDepth": 0,
"urlDepth": 0,
"userAgent": 2,
"robotsTxt": true,
"withImages": true
},
"dontScanKeywordsBlock": {
"checked": false,
"keywords": ""
},
"onlyScanKeywordsBlock": {
"checked": false,
"keywords": ""
},
"baseAuthBlock": {
"login": "",
"password": ""
},
"mailTriggerSettings": {
"emails": [
"lita.netpeak@gmail.com"
],
"interval": 1,
"enabled": false,
"enableExportAfterFinish": true
},
"scheduleSettings": {
"scheduleRepeatOption": 0
},
"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
}
}
}