Project Settings
Use case: With the AuditSite.getSettings method, check the settings of an Audit project.
General request parameters and instructions for using Serpstat API.
Request parameters | ||
Parameters | Value | Description |
id | any number or string | A request id: the response contains the same id. Enter any number (number) or text (string) value |
method | getSettings | API method name |
params | {...} / [...] | The object with parameters {...}, it lists all the following parameters and arrays [...] |
Response parameters | |
Parameter | Description |
id | Response id corresponds the request id |
result | Contains the answer |
domain | Project domain |
name | Project name |
subdomainsCheck | Subdomains check |
pagesLimit | Scan pages limit |
scanSpeed | Scan speed |
autoSpeed | Auto speed control |
autoUserAgent | User Agent auto switches at unsuccessful server response |
scanNoIndex | No-index pages scanning |
scanWrongCanonical | Wrong canonical pages scanning |
autoUserAgent | |
scanDuration | Scan duration |
folderDepth | Scan folder depth |
urlDepth | URL depth |
userAgent | User Agent |
robotsTxt | Robots.txt regulations check |
withImages | Scan images |
dontScanKeywordsBlock | Don’t scan pages with keywords in URL |
onlyScanKeywordsBlock | Scan only pages with keywords in URL |
baseAuthBlock | Access to websites shut down with BaseAuth |
login | BaseAuth login |
password | BaseAuth password |
mailTriggerSettings | Trigger mail settings |
emails | Array of emails trigger mail to be sent |
interval | Interval of trigger mailing |
enabled | Trigger mail enabling |
scheduleSettings | Scan schedule settings |
scheduleRepeatOption | Scan interval id |
scanSetting | Scan type settings |
type | Scan type mode id |
list | Arrays of URL to be scanned |
importedFilename | URL File name of previously imported URL |
errorsSettings | Advanced settings |
tiny_title | The minimum number of characters in title |
long_title | The maximum number of characters in title |
tiny_desc | The minimum number of characters in the description |
long_desc | The maximum number of characters in the description |
long_url | URL is too long |
large_image_size | Image size is too large |
large_page_size | Page size is too large |
many_external_links | Too many external links |
Credits for this method are not deducted.
{
"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
}
}
}