Аудит сайта (без проекта)

Запуск аудита

Формат запроса

POST /audit/create

Параметры в запросе

ИмяОбязательныйОписание
domainДаСайт для аудита. Пример : seranking.com
titleНетНазвание. Максимум 300 символов. По умолчанию будет равно domain
group_idНетid группы. По умолчанию 0 (general)
settingsНетНастройки аудита. Добавляются только те параметры, которые нужно изменить (их значение должно отличаться от значения по умолчанию).

Настройки аудита. Все параметры необязательные.

ИмяОписаниеВозможные значения Значение по умолчанию
schedule_typeЧастота сканирования.  manual
week
month		manual
schedule_dayДень запуска аудита1-311
schedule_hourЧас0-230
schedule_wdaysДни недели, по которым будет запускаться аудит (от 1 до 7).[1,2,3,4,5,6,7][]
send_reportОтправлять отчет с результатами аудита (1 – отправлять, 0 – не отправлять)1,01  
report_emailsСписок email, на которые будет отправлен отчет“”По умолчанию отчет отправляется на email аккаунта
source_siteСканировать ли все страницы сайта (начиная с главной страницы и переходя далее по внутренним ссылкам). Если указано (0), проверка только по sitemap или по списку переданных страниц.1,01
source_sitemapСканировать карту сайта (sitemap.xml)1,01
source_subdomainСканировать поддомены сайта. Если не выбрано (0) ссылки на поддомены сайта считаются внешними.1,00
source_fileИспользовать пользовательский список страниц.1,00
check_robotsСканировать сайт согласно списку действующих инструкций в файле robots.txt1,01
ignore_paramsИгнорировать параметры url0(не игнорировать),1(все), 2(пользовательские)0
custom_paramsСписок игнорируемых параметров. Используется если ignore_params=2utm_source, utm_medium, utm_term, utm_content, utm_campaign, cid, PHPSESSID
ignore_noindexИгнорировать noindex0,10
ignore_nofollowИгнорировать nofollow0,10
user_agentЗначение заголовка User-Agent (14 возможных вариантов для аудита сайта) 0-130 (seranking bot)
loginЛогин для Base HTTP аутентификации
passwordПароль для Base HTTP аутентификации
max_pagesМаксимальное количество страниц для сканирования1-3000001000
max_depthМаксимальная глубина сканирования1-10010
max_reqМаксимальное количество запросов в секунду1-500500
max_redirectsМаксимальное количество редиректов1-505
min_title_lenМинимальный размер title1-1000020
max_title_lenМаксимальный размер title1-1000065
min_description_lenМинимальный размер meta description1-100001
max_description_lenМаксимальный размер meta description1-10000158
max_sizeМаксимальный размер страницы в килобайтах1-1000003000
min_wordsМинимальное количество слов на странице1-10000250
max_h1_lenМаксимальный размер заголовков H11-10000100
max_h2_lenМаксимальный размер заголовков H21-10000100
allowРазрешить сканирование только тех страниц, URL-адреса которых начинаются с
disallowЗапретить сканирование страниц, URL-адреса которых начинаются с
hideСкрыть URL-адреса и ресурсы, которые начинаются с
versionВерсия аудита‘1.0’, ‘2.0’Последняя доступная версия для аккаунта

Результат

В случае успеха сервер возвращает ID отчета.

Пример

{

  “id”: 100000222

}

Перезапуск аудита

Формат запроса

POST /audit/{report_id}/recheck

Результат

В случае успеха сервер возвращает HTTP 200.

Список аудитов

Формат запроса

POST /audit/list

Параметры в запросе.

ИмяОписание
limitКоличество записей в списке
offsetСмещение
group_idid группы. По умолчанию 0 (general)
only_with_projectТолько аудиты привязанные к проекту
searchФильтр поиска по title или URL-адресу сайта
date_startФильтр поиска по дате запуска аудита.
date_endФильтр поиска по дате завершения аудита.

Результат

Пример

{

  “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

}

Переименование аудита

Формат запроса

POST /audit/{report_id}/edit

Параметры в запросе.

ИмяОписание
titleНовое название аудита. Максимум 300 символов.

Результат

В случае успеха сервер возвращает HTTP 200.

Удаление аудита

Формат запроса

POST /audit/{report_id}/delete

Результат

В случае успеха сервер возвращает HTTP 200.

Статус аудита

Формат запроса

GET /audit/{report_id}

или

GET /audit/?id={id}

Результат

В случае успеха сервер возвращает статус аудита.

Пример

{

  “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

}

Параметры ответа

ИмяОписание
statuscancelled – аудит отменен;
expired – аудит просрочен, с момента выполнения аудита прошло более 3 месяцев;
queued – аудит в очереди;
processing – аудит в процессе выполнения;
finished – аудит завершен.
start_timeВремя начала аудита 
audit_timeВремя окончания аудита
total_pagesКоличество просканированных страниц
total_warningsКоличество предупреждений
total_errorsКоличество важных проблем
total_passedКоличество пройденных проверок

Отчет по аудиту

Данные доступны, если только аудит завершен (“is_finished”: true).

Формат запроса

GET /audit/{report_id}/report

Результат

“is_finished”: true – доступные данные по отчету аудита.
“is_finished”: false – если аудит не завершен.

Пример

{

  “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”

 }

Параметры ответа

ИмяОписание
is_finishedСтатус аудита
versionВерсия аудита
domain_propsИнформация о домене (включает список общих параметров домена)
score_percentСостояние сайта (в %)
audit_timeВремя окончания аудита
versionВерсия выполненного аудита
total_pagesКоличество просканированных страниц
total_noticesКоличество замечаний
total_warningsКоличество предупреждений
total_errorsКоличество важных проблем
total_passedКоличество пройденных проверок
sectionsРазделы аудита
uidИдентификатор раздела
nameНазвание раздела
propsСписок проверок раздела
ИмяОписание
expdateДата истечения срока действия домена
ipIP-адрес
backlinksКоличество ссылающихся страниц (бэклинков)
index_googleКоличество проиндексированных страниц в Google
index_bingКоличество проиндексированных страниц в Bing
index_yahooКоличество проиндексированных страниц в Yahoo
nameНазвание проверки
statusСтатус проверки (warning | error | passed) 
codeКод проверки 
valueЗначение проверки

Список страниц

Список страниц по указанной проверке

Формат запроса

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

Параметры в запросе

ИмяОбязательныйОписание
codeДаКод проверки. Для подробностей см. GET /audit/{report_id}/report
limitНетКоличество ссылок (максимум 100).
offsetНетСмещение

Результат

В случае успеха сервер возвращает список страниц по указанной проверке.

Пример 
Для urls_type: simple_urls_array

{

“total_urls”: 10,

“urls”: [

  “https://seranking.com/keyword-suggestion-tool.html”,

…

],

“urls_type”: “simple_urls_array”

}

Параметры ответа

ИмяОписание
total_urlsВсего ссылок
urlsСписок ссылок. Формат списка зависит от типа проверки
urls_typeТип списка:
simple_urls_array
urls_and_single_source

Ошибки

HTTP-код Сообщение об ошибке
400Invalid code

История по аудиту

Формат запроса

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

Параметры в запросе

ИмяОбязательныйОписание
dateДаДата проведения аудита

Пример

{

    “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

    }

}

Параметры ответа

ИмяОписание
audit_timeВремя окончания аудита
domain_dataПараметры, которые относятся к домену и сайту в целом
settingsНастройки (параметр может отсутствовать, если настройки не задавались отдельно для сайта)
pages_dataПараметры проверки страниц
totalsДля подробностей см. GET /audit/{report_id}
versionВерсия выполненного аудита