Website audit (standalone)

Running an audit

Request format

POST /audit/create

Request parameters

NameRequiredDescription
domainYesWebsite for audit. Example: seranking.com
titleNoAudit title. Up to 300 characters. By default, will have the title of domain
group_idNoAudit group id. By default, set to 0 (general)
settingsNoAudit settings. Only the parameters that need changing are added (their value must be different from the default value).

Audit settings. All parameters are optional.

NameDescriptionPossible valuesDefault value
schedule_typeScanning frequency manual
week
month
manual
schedule_dayAudit start day1-311
schedule_hourAudit start hour0-230
schedule_wdaysThe days of the week on which the audit will run (from 1 to 7).[1,2,3,4,5,6,7][]
send_reportSend a report with audit results (1 – send, 0 – do not send)1,01  
report_emailsList of emails to send the report to“”By default, the report is sent to the account email
source_siteСrawl all pages of the site or not (starting from the main page and following internal links). If set to (0), only the sitemap or the list of submitted pages will be crawled.1,01
source_sitemapCrawl sitemap (sitemap.xml)1,01
source_subdomainCrawl website subdomains. Links to the website subdomains are considered external if not set to (0)1,00
source_fileUse a custom page list1,00
check_robotsCrawl the site according to the list of current instructions in the robots.txt file1,01
ignore_paramsIgnore URL parameters0(do not ignore), 1(all), 2(custom)0
custom_paramsList of ignored parameters. Used when ignore_params=2utm_source, utm_medium, utm_term, utm_content, utm_campaign, cid, PHPSESSID
ignore_noindexIgnore noindex0,10
ignore_nofollowIgnore nofollow0,10
user_agentUser-Agent header value (14 possible options for Website Audit) 0-130 (seranking bot)
loginLogin for Base HTTP authentication
passwordPassword for Base HTTP authentication
max_pagesMaximum number of pages to scan1-3000001000
max_depthMaximum scanning depth1-10010
max_reqMaximum number of requests per second1-500500
max_redirectsMaximum number of redirects1-505
min_title_lenMinimum title length1-1000020
max_title_lenMaximum title length1-1000065
min_description_lenMinimum meta description length1-100001
max_description_lenMaximum meta description length1-10000158
max_sizeMaximum page size in kilobytes1-1000003000
min_wordsMinimum number of words per page1-10000250
max_h1_lenMaximum size of H1 headers1-10000100
max_h2_lenMaximum size of H2 headers1-10000100
allowOnly allow checking for pages with URLs starting with
disallowDisallow checking for pages with URLs starting with
hideHide URLs and resources starting with

Result

If successful, the server returns the ID of the audit.

Example

{
“id”: 100000222
}

Restarting an audit

Request format

POST /audit/{report_id}/recheck

Result

If successful, the server returns the 200 HTTP code.

List of audits

Request format

POST /audit/list

Request parameters

NameDescription
limitNumber of entries in the list
offsetOffset value
group_idAudit group id. By default, set to 0 (general)
only_with_projectOnly audits with a project 
searchSearch filter by the title or website URL.
date_startSearch filter by the audit start date.
date_endSearch filter by the audit end date.

Result

Example

{
“items”: [
{
“id”: 6193559,
“url”: “http://seranking.com”,
“title”: “seranking.com”,
“has_project”: true,
“last_update”: “2023-06-16”,
“status”: “finished”,
“stats”: {
“score”: 66,
“errors”: 73,
“warnings”: 448,
“notices”: 389,
“crawled”: 100
},
“prev_stats”: {
“score”: 76,
“errors”: 72,
“warnings”: 447,
“notices”: 387,
“crawled”: 100
}
},

]
“total”: 810
}

Renaming an audit

Request format

POST /audit/{report_id}/edit

Request parameters

NameDescription
titleNew audit name. Maximum 300 characters.

Result

If successful, the server returns the 200 HTTP code.

Deleting an audit

Request format

POST /audit/{report_id}/delete

Result

If successful, the server returns the 200 HTTP code.

Audit status

Request format

GET /audit/{report_id}

or

GET /audit/?id={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

NameDescription
statuscanceled – 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_timeAudit start time
audit_timeAudit end time
total_pagesTotal number of scanned pages
total_warningsTotal number of warnings 
total_errorsTotal number of critical errors
total_passedTotal number of passed checks

Audit report

Data is available only if the audit has been completed (“is_finished”: true).

Request format

GET /audit/{report_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”: “Название раздела”,
“props”: [
{
“code”: “_images_500_count”,
“status”: “passed”,
“name”: “Изображений с ответом 5хх”,
“value”: “0”
},
…],

],
“score_percent”: 79,
“total_pages”: 10,
“total_warnings”: 71,
“total_errors”: 21,
“total_passed”: 810,
“audit_time”: “2018-09-11 16:13:41”
}

Response parameters

NameDescription
is_finishedAudit status
domain_propsDomain information (includes a list of general domain settings)
score_percentHealth Score (%)
audit_timeAudit end time
total_pagesTotal number of scanned pages
total_noticesTotal number of notices
total_warningsTotal number of warnings
total_errorsTotal number of critical errors
total_passedTotal number of passed checks
sectionsAudit sections
uidSection ID
nameSection name
propsList of section checks
NameDescription
expdateDomain expiration date
ipDomain IP address
backlinksNumber of backlinks
index_googleNumber of pages in Google’s index
index_bingNumber of pages in Bing’s index
index_yahooNumber of pages in Yahoo’s index
nameName
statusStatus (warning | error | passed) 
codeCheck code
valueCheck value

List of pages

List of pages for the specified check.

Request format

GET /audit/{report_id}/links?code={code}&limit=100&offset=10

Request parameters

NameRequiredDescription
codeYesCheck code. For more details, refer to GET /audit/{report_id}/report
limitNoTotal number of links. Max number of links – 1000
offsetNoOffset value

Result

If successful, the server returns the list of pages for the specified audit.

Example

For urls_type: simple_urls_array

{
“total_urls”: 10,
“urls”: [
“https://seranking.com/keyword-suggestion-tool.html”,

],
“urls_type”: “simple_urls_array”
}

Response parameters

NameDescription
total_urlsTotal number of URLs
urlsList of URLs. The format of the list depends on the type of check
urls_typeList type:
simple_urls_array
urls_and_single_source

Errors

HTTP code Error message
400Invalid code

Audit history

Request format

GET /audit/{report_id}/history?date=2018-06-01

Request parameters

NameRequiredDescription
dateYesDate of the audit

Example

{
“audit_time”: “2023-05-29 00:19:41”,
“domain_data”: {
“dt”: 88,
“domain”: “seranking.com”,
“domains”: “15135”,
“expdate”: “2024-09-16”,
“updated”: “2023-05-29 00:01:03”,
“backlinks”: “810981”,
“index_bing”: 545828,
“all_checked”: true,
“index_yahoo”: 400372,
“index_google”: “131473”
},
“settings”: {
“schedule_type”: “week”,
“schedule_day”: 1,
“schedule_hour”: 0,
“schedule_wday”: 1,
“schedule_wdays”: [
“1”
],
“schedule_repeat”: 0,
“schedule_repeat_interval”: 2,
“send_report”: 1,
“report_email”: “”,
“report_emails”: “”,
“source_site”: 1,
“source_sitemap”: 1,
“source_subdomain”: 0,
“source_file”: 0,
“check_robots”: 1,
“ignore_params”: 0,
“custom_params”: “utm_source, utm_medium, utm_term, utm_content, utm_campaign, cid, PHPSESSID”,
“user_agent”: 0,
“login”: “”,
“password”: “”,
“max_pages”: 500,
“max_depth”: 10,
“max_req”: 500,
“min_title_len”: 20,
“max_title_len”: 65,
“min_description_len”: 1,
“max_description_len”: 158,
“max_size”: 3000,
“min_words”: 250,
“max_redirects”: 5,
“disable_audit”: 0,
“disabled_issues”: [],
“ignore_noindex”: 0,
“ignore_nofollow”: 0,
“max_h1_len”: 100,
“max_h2_len”: 100,
“allow”: “”,
“disallow”: “”,
“hide”: “”
},
“pages_data”: {
“css_big”: 343,
“h1_long”: 1,
“http4xx”: 2,
“js_many”: 48,
“links3xx”: 308,
“image_big”: 2,
“h2_missing”: 29,
“html_ratio”: 263,
“title_long”: 30,
“amp_missing”: 1,
“css_not_min”: 1,
“extlinks3xx”: 424,
“extlinks4xx”: 10,
“less_inlink”: 1,
“redirect3xx”: 13,
“title_short”: 11,
“h1_duplicate”: 31,
“image_no_alt”: 426,
“same_title_h1”: 1,
“links_nofollow”: 335,
“low_word_count”: 11,
“hreflang_return”: 50,
“links_no_anchor”: 415,
“title_duplicate”: 2,
“description_long”: 110,
“extlinks_nofollow”: 424,
“hreflang_xdefault”: 391,
“blocked_by_noindex”: 59,
“extlinks_no_anchor”: 60,
“redirect_temporary”: 5,
“blocked_by_nofollow”: 3,
“description_duplicate”: 2
},
“totals”: {
“total_pages”: 500,
“total_warnings”: 1917,
“total_errors”: 59,
“total_passed”: 102
}
}

Response parameters

NameDescription
audit_timeAudit end time
domain_dataParameters related to the domain and to the site as a whole
settingsSettings (the parameter may be missing if the site settings were not set separately)
pages_dataPages check parameters
totalsFor more details, refer to GET /audit/{report_id}/report