List of carried out audits

AuditSite.getList — method provides you with a list of audits carried out by project id. This list can be found in the project Audit summary report.

a list of audits carried out by project id

Use case: With the AuditSite.getList method, check the details of all the audits you ran within a specific Audit project.

General request parameters and instructions for using Serpstat API

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.getList
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)
limit	Limit of chosen data	int	no	30	3 (any limits you need)
offset	A page number (number value)	int	no	0	2 (any offset value you need)

Response parameters
Parameters	Description
id	Response id corresponds the request id
result	Contains the answer
data	Array with data
reportId	Report id
date	Date
sdo	Serpstat Domain Optimization score
pagesLimit	What scan limit was set
pagesScanned	Number of checked pages (charged limits)
criticalCount	Number of critical errors
nonCriticalCount	Number of non-critical errors
virusesCount	Number of pages with viruses
progress	Audit progress, if the audit is over then the value is 100
stoped	false- ended on its own; true- ыtopped by user.

Reports are set in order from the newest to the latest: recently carried out audit tops the list.
Credits for this method are not deducted.

Example

Request data:

{
     "id":1,
 "method": "AuditSite.getList",
 "params":{
  "projectId":123456,
  "limit":3,
  "offset":0

    }
}

Response data:

{
    "id": "1",
    "result": [
        {
            "reportId": 4186494,
            "date": "2021-07-08 13:11:34",
            "sdo": 89,
            "pagesLimit": 5000,
            "pagesScanned": 651,
            "criticalCount": 41,
            "nonCriticalCount": 2117,
            "virusesCount": 0,
            "progress": 100,
            "stoped": false
        },
        {
            "reportId": 4186452,
            "date": "2021-07-08 11:59:21",
            "sdo": 89,
            "pagesLimit": 5000,
            "pagesScanned": 652,
            "criticalCount": 40,
            "nonCriticalCount": 2126,
            "virusesCount": 0,
            "progress": 100,
            "stoped": false
        },
        {
            "reportId": 4186450,
            "date": "2021-07-08 11:56:36",
            "sdo": 96,
            "pagesLimit": 5000,
            "pagesScanned": 0,
            "criticalCount": 1,
            "nonCriticalCount": 11,
            "virusesCount": 0,
            "progress": 100,
            "stoped": true
        }
    ]
}