Get access to 30+ marketing and SEO tools. analyze competitors, keywords, and backlinks for free..
Sign in Sign Up

We use cookies to make Serpstat better. By clicking "Accept cookies", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. Learn more

Audit settings saving (AuditSite.setSettings)

AuditSite.setSettings — method saves settings in a suggested project.


Request parameters
Parameters Description
id A request id: the response contains the same id. Enter any number (number) or text (string) value
method API method name:AuditSite.setSettings
params The object with parameters {...}, it lists all the following parameters and arrays [...]
projectId Audit project id
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 Incorrect canonical pages scanning
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 File name of previously imported URL

Response parameters
Parameters Description
id Response id corresponds the request id
result Contains the answer

 Credits for this method are not deducted.

Request data:

 "method": "AuditSite.setSettings",
     "mainSettings": {
        "domain": "",
        "name": "",
        "subdomainsCheck": true,
        "pagesLimit": 5321,
        "scanSpeed": 1,
        "autoSpeed" : true,
        "autoUserAgent": 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": [],

Response data:

    "id": "1",
    "result": null