Запуск аудита
Формат запроса
POST /audit/createПараметры в запросе
| Имя | Обязательный | Описание |
| domain | Да | Сайт для аудита. Пример : seranking.com |
| title | Нет | Название. Максимум 300 символов. По умолчанию будет равно domain |
| group_id | Нет | id группы. По умолчанию 0 (general) |
| settings | Нет | Настройки аудита. Добавляются только те параметры, которые нужно изменить (их значение должно отличаться от значения по умолчанию). |
Настройки аудита. Все параметры необязательные.
| Имя | Описание | Возможные значения | Значение по умолчанию |
| schedule_type | Частота сканирования. | manual week month | manual |
| schedule_day | День запуска аудита | 1-31 | 1 |
| schedule_hour | Час | 0-23 | 0 |
| schedule_wdays | Дни недели, по которым будет запускаться аудит (от 1 до 7). | [1,2,3,4,5,6,7] | [] |
| send_report | Отправлять отчет с результатами аудита (1 – отправлять, 0 – не отправлять) | 1,0 | 1 |
| report_emails | Список email, на которые будет отправлен отчет | “” | По умолчанию отчет отправляется на email аккаунта |
| source_site | Сканировать ли все страницы сайта (начиная с главной страницы и переходя далее по внутренним ссылкам). Если указано (0), проверка только по sitemap или по списку переданных страниц. | 1,0 | 1 |
| source_sitemap | Сканировать карту сайта (sitemap.xml) | 1,0 | 1 |
| source_subdomain | Сканировать поддомены сайта. Если не выбрано (0) ссылки на поддомены сайта считаются внешними. | 1,0 | 0 |
| source_file | Использовать пользовательский список страниц. | 1,0 | 0 |
| check_robots | Сканировать сайт согласно списку действующих инструкций в файле robots.txt | 1,0 | 1 |
| ignore_params | Игнорировать параметры url | 0(не игнорировать),1(все), 2(пользовательские) | 0 |
| custom_params | Список игнорируемых параметров. Используется если ignore_params=2 | utm_source, utm_medium, utm_term, utm_content, utm_campaign, cid, PHPSESSID | |
| ignore_noindex | Игнорировать noindex | 0,1 | 0 |
| ignore_nofollow | Игнорировать nofollow | 0,1 | 0 |
| user_agent | Значение заголовка User-Agent (14 возможных вариантов для аудита сайта) | 0-13 | 0 (seranking bot) |
| login | Логин для Base HTTP аутентификации | ||
| password | Пароль для Base HTTP аутентификации | ||
| max_pages | Максимальное количество страниц для сканирования | 1-300000 | 1000 |
| max_depth | Максимальная глубина сканирования | 1-100 | 10 |
| max_req | Максимальное количество запросов в секунду | 1-500 | 500 |
| max_redirects | Максимальное количество редиректов | 1-50 | 5 |
| min_title_len | Минимальный размер title | 1-10000 | 20 |
| max_title_len | Максимальный размер title | 1-10000 | 65 |
| min_description_len | Минимальный размер meta description | 1-10000 | 1 |
| max_description_len | Максимальный размер meta description | 1-10000 | 158 |
| max_size | Максимальный размер страницы в килобайтах | 1-100000 | 3000 |
| min_words | Минимальное количество слов на странице | 1-10000 | 250 |
| max_h1_len | Максимальный размер заголовков H1 | 1-10000 | 100 |
| max_h2_len | Максимальный размер заголовков H2 | 1-10000 | 100 |
| allow | Разрешить сканирование только тех страниц, URL-адреса которых начинаются с | ||
| disallow | Запретить сканирование страниц, URL-адреса которых начинаются с | ||
| hide | Скрыть URL-адреса и ресурсы, которые начинаются с |
Результат
В случае успеха сервер возвращает ID отчета.
Пример
{
“id”: 100000222
}Перезапуск аудита
Формат запроса
POST /audit/{report_id}/recheckРезультат
В случае успеха сервер возвращает HTTP 200.
Список аудитов
Формат запроса
POST /audit/listПараметры в запросе.
| Имя | Описание |
| limit | Количество записей в списке |
| offset | Смещение |
| group_id | id группы. По умолчанию 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
}Параметры ответа
| Имя | Описание |
| status | cancelled – аудит отменен; 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 | Статус аудита |
| domain_props | Информация о домене (включает список общих параметров домена) |
| score_percent | Состояние сайта (в %) |
| audit_time | Время окончания аудита |
| total_pages | Количество просканированных страниц |
| total_notices | Количество замечаний |
| total_warnings | Количество предупреждений |
| total_errors | Количество важных проблем |
| total_passed | Количество пройденных проверок |
| sections | Разделы аудита |
| uid | Идентификатор раздела |
| name | Название раздела |
| props | Список проверок раздела |
| Имя | Описание |
| expdate | Дата истечения срока действия домена |
| ip | IP-адрес |
| 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: urls_and_sources
{
“total_urls”: 10,
“urls”: [
{
“id”: 1248462,
“url”: “https://seranking.com/”
},
…
],
“urls_type”: “urls_and_sources”
}Для urls_type: simple_urls_array
{
“total_urls”: 10,
“urls”: [
“https://seranking.com/keyword-suggestion-tool.html”,
…
],
“urls_type”: “simple_urls_array”
}Для urls_type: duplicate_props
{
“total_urls”: 2,
“urls”: {
“Online SEO Tools by SE Ranking”: {
“found_on_urls”: [
{
“url”: “https://seranking.com/position-tracking.html”,
“id”: “1248466”,
“cnt”: “10”
},
…
],
}
,
“urls_type”: “duplicate_props”
}Параметры ответа
| Имя | Описание |
| total_urls | Всего ссылок |
| urls | Список ссылок. Формат списка зависит от типа проверки |
| urls_type | Тип списка: simple_urls_array duplicate_props urls_and_single_source urls_and_sources |
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Invalid 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} |