Audit basic information
AuditSite.getBasicInfo — method returns basic report information.
Use case: With the AuditSite.getBasicInfo method, get the results of the Audit report and update the site according to this information.
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.getBasicInfo |
| params | The object with parameters {...}, it lists all the following parameters and arrays [...] | no |
|
| |
| reportId | Audit report id | int | no | 1251109 (any report ID number) | |
| Response parameters | |
| Parameters | Description |
| id | Response id corresponds the request id |
| result | Contains the answer |
| reportId | Report id |
| date | Starting date of report |
| sdo | Serpstat Domain Optimization index |
| highCount | Number of high priority errors |
| mediumCount | Number of medium priority errors |
| lowCount | Number of low priority errors |
| informationCount | Number of informative messages |
| virusesCount | Number of pages with viruses |
| progress | Audit progress, if the audit is over then the value is 100 |
| stoped | 0- ended on its own; 1- stopped by user. |
| specialStopReason | Audit stopping code |
| checkedPageCount | Number of scanned pages |
| totalCheckedPageCount | Number of scanned URL (including pages, redirects, images) |
| redirectCount | Number of pages where redirect was found |
| captchaDetected | Captcha occurrence while parsing |
Credits for this method are not deducted.
Request data:
{
"id":1,
"method": "AuditSite.getBasicInfo",
"params":{
"reportId":123456
}
}Response data:
{
"id": "1",
"result": {
"reportId": 123456,
"date": "2018-08-19 00:01:46",
"sdo": 87,
"highCount": 110,
"mediumCount": 1694,
"lowCount": 248,
"informationCount": 3151,
"virusesCount": 0,
"progress": 100,
"stoped": 0,
"specialStopReason": 0,
"checkedPageCount": 1565,
"totalCheckedPageCount": 1565,
"redirectCount": 286,
"captchaDetected": false
}
}