API Description
Audit
Audit status
Request format
GET /audit/{site_id}Result
If successful, the server returns the audit status.
Example
{ "status": "finished", "start_time": "2018-06-15 12:41:13", "audit_time": "2018-09-11 16:13:41", "total_pages": 10, "total_warnings": 71, "total_errors": 21, "total_passed": 810 }
Response parameters
| Name | Description |
| status | canceled – the audit has been canceled;expired – the audit is expired as more than 3 months have passed since it was completed.queued – the audit is currently in a queue;processing – the audit is in progress;finished – the audit has been completed. |
| start_time | Audit start time |
| audit_time | Audit end time |
| total_pages | Total number of scanned pages |
| total_warnings | Total number of warnings |
| total_errors | Total number of critical errors |
| total_passed | Total number of passed checks |
Audit report
Data is available only if the audit has been completed (“is_finished”: true)
Request format
GET /audit/{site_id}/report
Result
“is_finished”: true – available data for the audit report.
“is_finished”: false – if the audit is not completed.
Example
{ "is_finished": false}
{ "is_finished": true,
"domain_props":
{ "archiveOrg": "2003-02-26",
"backlinks": "4",
},"sections": [
{
"uid": "tech_audit",
"name": "Section name",
"props": [
{
"code": "_images_500_count",
"status": "passed",
"name": "Image with 5xx status",
"value": "0"
},
],
],
"score_percent": 79,
"total_pages": 10,
"total_warnings": 71,
"total_errors": 21,
"total_passed": 810,
"screenshot": "http://host/screenshots/147683.jpg",
"audit_time": "2018-09-11 16:13:41"
}
Response parameters
| Name | Description |
| is_finished | Audit status |
| domain_props | Domain information (includes a list of general domain settings) |
| score_percent | Health Score (%) |
| screenshot | Screenshot link |
| audit_time | Audit end time |
| total_pages | Total number of scanned pages |
| total_warnings | Total number of warnings |
| total_errors | Total number of critical errors |
| total_passed | Total number of passed checks |
| sections | Audit sections |
| uid | Section ID |
| name | Section name |
| props | List of section checks |
Domain information. Possible parameters
| Name | Description |
| avgLoadSpeed | Average page load speed |
| archiveOrg | Age in archive.org |
| expdate | Domain expiration date |
| IpCountry | Country |
| ip | IP |
| mozDomainAuthority | Moz Domain Authority |
| AlexaRank | Alexa Rank |
| backlinks | Backlinks |
| index_google | Pages in Google |
| index_bing | Pages in Bing |
| index_yahoo | Pages in Yahoo |
List of section checks
| name | Description |
| status | warning | error | passed |
| code | Check code (only in the following sections: uid = props_*) |
| value | Check value (only in the following sections: uid = props_*) |
List of pages
The method allows to get a list of pages for the specified check.
Request format
GET /audit/{site_id}/links?code={code}&limit=100&offset=10
Request parameters
| Name | Required | Description |
| code | Yes | Refer to GET /audit/{site_id}/report |
| limit | No | Total number of links. Max number of links – 100 |
| offset | No | Offset value |
Result
If successful, the server returns the list of pages for the specified check.
For the urls_type: simple_urls_array
{"total_urls": 10,"urls": [ "https://seranking.com/keyword-suggestion-tool.html",],"urls_type": "simple_urls_array"}
Response parameters
| Name | Description |
| total_urls | Total number of URLs |
| urls | List of URLs. The format of the list depends on the type of check |
| urls_type | List type:simple_urls_arrayurls_and_single_source |
Errors
| HTTP code | Error message |
| 400 | Invalid code |
Audit history
Request format
GET /audit/{site_id}/history?date=2018-06-01
Request parameters
| Name | Required | Description |
| date | Yes | Audit date |
Example
GET /audit/{site_id}/history?date=2018-06-01
Response parameters
| Name | Description |
| audit_time | Audit end time |
| domain_data | Parameters related to the domain and to the site as a whole |
| settings | Settings (the parameter may be missing if the site settings were not set separately) |
| pages_data | Page check parameters |
| totals | Refer to GET /audit/{site_id} |