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

URL list for scanning (AuditSite.getScanUserUrlList)

getScanUserUrlList — method returns a list of URLs which were audited if the scan type was specified for assigned URLs (imported or hand-typed).

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 getScanUserUrlList API method name
params {...} The object with parameters {...}, it lists all the following parameters and arrays [...]
projectId any number or string Project id

Response parameters
Parameters Description
id Response id corresponds the request id
result Contains the answer
urls URL list
scanType Scan type
isImported Imported URL list 

 Credits for this method are not deducted.

Example
Request data:

{
            "method": "AuditSite.getScanUserUrlList",
            "params": {
                "projectId": 123456
            },
        
            "id": 0
        }
Response data:
{
    "id": "",
    "result": {
        "urls": [
            "http://audit.test.pages/largeImage/linksToLargeImagesExist.html",
            "http://audit.test.pages/charsetMissing/charsetEmpty.html",
            "http://audit.test.pages/pageSize/largePageSize.html" 
        ],
        "scanType": 2,
        "isImported": true
    }
}

An example of an error if the audit was launched using the "All pages" crawl type:

{
    "id": "0",
    "error": {
        "code": -32131,
        "message": "Scan url list not found",
        "data": {}
    }
}