URL list for scanning

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

a list of URLs which were audited

Use case: With the AuditSite.getScanUserUrlList method, you can check what pages have been scanned by the Audit tool.

Request parameters

Parameter

Description

Type

Optional

Default value

Value Options

id

A request id: the response contains the same id.

int/string

no

Text or number value

method

API method name

string

no

AuditSite.getScanUserUrlList

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

no

projectId

Audit project id

int

no

1251109 (any project ID number)

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": {}
    }
}

Share this article with your friends

Are you sure?

Introducing Serpstat

Find out about the main features of the service in a convenient way for you!

Please send a request, and our specialist will offer you education options: a personal demonstration, a trial period, or materials for self-study and increasing expertise — everything for a comfortable start to work with Serpstat.

Name

Email

Phone

We are glad of your comment
I agree to Serpstat`s Privacy Policy.

Thank you, we have saved your new mailing settings.

Open support chat