Содержание
API для анализа сайта
Запуск аудита
Формат запроса
POST /audit/{site_id}/recheck
Результат
В случае успеха сервер возвращает HTTP 200.
Статус аудита
Формат запроса
GET /audit/{site_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/{site_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»: «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»: «https://host/screenshots/147683.jpg»,
«audit_time»: «2018-09-11 16:13:41»
}
Параметры ответа
Имя | Описание |
is_finished | Статус аудита |
domain_props | Информация о домене. Возможные параметры |
score_percent | Рейтинг в % |
screenshot | Ссылка на скриншот |
audit_time | Время окончания аудита |
total_pages | Количество просканированных страниц |
total_notices | Количество замечаний |
total_warnings | Количество предупреждений |
total_errors | Количество важных проблем |
total_passed | Количество пройденных проверок |
sections | Разделы аудита |
id | Идентификатор раздела |
name | Название раздела |
props | Список проверок раздела |
Информация о домене. Возможные параметры
Имя | Описание |
avgLoadSpeed | Средняя скорость загрузки |
archiveOrg | Возраст в archive.org |
expdate | Дата окончания домена |
IpCountry | Страна |
ip | IP |
yandex_x | Yandex ИКС |
AlexaRank | Рейтинг Alexa |
backlinks | Бэклинки |
index_google | Страниц в Google |
index_bing | Страниц в Bing |
index_yahoo | Страниц в Yahoo |
index_yandex | Страниц в Yandex |
Список проверок раздела
Имя | Описание |
status | warning | error | passed |
code | Код проверки (только в разделах uid = props_*) |
value | Значение проверки (только в разделах uid = props_*) |
Список страниц
Список страниц по указанной проверке.
Формат запроса
GET /audit/{site_id}/links?code={code}&limit=100&offset=10
Параметры запроса
Имя | Обязательный | Описание |
code | Да | См. GET /audit/{site_id}/report |
limit | Нет | Количество ссылок. Максимум 100 |
offset | Нет | Смещение |
Результат
В случае успеха сервер возвращает список страниц по указанной проверке.
Пример
{
«total_urls»: 10,
«urls»: [
{
«id»: 1248462,
«url»: «https://seranking.com/»
},
…
],
«urls_type»: «urls_and_sources»
}
«total_urls»: 10,
«urls»: [
«https://seranking.com/keyword-suggestion-tool.html»,
…
],
«urls_type»: «simple_urls_array»
{
«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/{site_id}/history?date=2018-06-01
Параметры в запросе
Имя | Обязательный | Описание |
date | Да | Дата проведения аудита |
Пример
{
«audit_time»: «2018-06-01 13:25:29»,
«domain_data»: {
«age»: «1»,
«AlexaRank»: «22»,
«archiveOrg»: «ew»,
«AvoidInterstitials»: «1»,
«AvoidInterstitials_mobile»: «1»,
«AvoidLandingPageRedirects»: «1»,
«AvoidLandingPageRedirects_mobile»: «1»,
«AvoidPlugins»: «1»,
«AvoidPlugins_mobile»: «1»,
«commonHomepageVars»: «0»,
«ConfigureViewport»: «1»,
«ConfigureViewport_mobile»: «1»,
«Correct404Pages»: «1»,
«EnableGzipCompression»: «0»,
«EnableGzipCompression_mobile»: «1»,
«expdate»: «2018-10-10»,
«HasFavicon»: «1»,
«hasFlash»: «0»,
«hasHttps»: «0»,
«hasRobotsTxt»: «1»,
«HasSeofriendlyUrls»: «1»,
«hasXmlSitemap»: «1»,
«index_yahoo»: «1»,
«index_yandex»: «9»,
«ip»: «148.251.49.8»,
«IpCountry»: «Germany»,
«IsSafeBrowsing»: «1»,
«LeverageBrowserCaching»: «0»,
«LeverageBrowserCaching_mobile»: «0»,
«MainResourceServerResponseTime»: «1»,
«MainResourceServerResponseTime_mobile»: «1»,
«MinifyCss»: «1»,
«MinifyCss_mobile»: «1»,
«MinifyHTML»: «0»,
«MinifyHTML_mobile»: «1»,
«MinifyJavaScript»: «0»,
«MinifyJavaScript_mobile»: «1»,
«MinimizeRenderBlockingResources»: «0»,
«MinimizeRenderBlockingResources_mobile»: «0»,
«OnYandexCatalog»: «0»,
«OptimizeImages»: «0»,
«OptimizeImages_mobile»: «0»,
«PrioritizeVisibleContent»: «1»,
«PrioritizeVisibleContent_mobile»: «1»,
«SizeContentToViewport»: «1»,
«SizeContentToViewport_mobile»: «1»,
«SizeTapTargetsAppropriately»: «1»,
«SizeTapTargetsAppropriately_mobile»: «1»,
«UseLegibleFontSizes»: «1»,
«UseLegibleFontSizes_mobile»: «1»,
«WwwRedir»: «0»,
«avgLoadSpeed»: «117.4000»
},
«settings»: {
«schedule_type»: «manual»,
«schedule_day»: 1,
«schedule_hour»: 1,
«schedule_wday»: 1,
«source_site»: 1,
«source_subdomain»: 0,
«source_sitemap»: «0»,
«source_file»: 0,
«check_robots»: «1»,
«ignore_params»: 0,
«custom_params»: «utm_source, utm_medium, cid, PHPSESSID»,
«user_agent»: 0,
«login»: «»,
«password»: «»,
«max_depth»: 10,
«max_req»: «5»,
«min_title_len»: 10,
«max_title_len»: 70,
«min_description_len»: 50,
«max_description_len»: 320,
«max_h1_len»: 60,
«max_h2_len»: 60,
«min_words»: «500»,
«max_links»: «10»,
«max_size»: «10»,
«max_redirects»: «3»,
«max_pages»: «10»
},
«pages_data»: {
«_2xx_pagesCount»: 10,
«_3xx_pagesCount»: 0,
«_4xx_pagesCount»: 0,
«_5xx_pagesCount»: 0,
«_too_big_pagesCount»: 10,
«_too_long_url_pagesCount»: 0,
«_blocked_by_robotstxt_pagesCount»: 0,
«_blocked_by_xrobots_pagesCount»: «0»,
«_blocked_by_nofollow_pagesCount»: 0,
«_meta_refresh_pagesCount»: 0,
«_rel_canonical_pagesCount»: 8,
«_no_rel_canonical_pagesCount»: 2,
«_duplicate_canonical_pagesCount»: 0,
«_duplicate_canonical_tag»: 0,
«_rel_alternate_pagesCount»: 10,
«_hreflang_pagesCount»: 10,
«_no_hreflang_pagesCount»: 0,
«_error_hreflang_pagesCount»: 0,
«_duplicate_title_pagesCount»: 0,
«_no_title_pagesCount»: 0,
«_long_title_pagesCount»: 0,
«_short_title_pagesCount»: 0,
«_no_descr_pagesCount»: 0,
«_duplicate_descr_pagesCount»: 0,
«_short_descr_pagesCount»: 0,
«_long_descr_pagesCount»: 0,
«_duplicate_content_pagesCount»: 0,
«_low_word_count_pagesCount»: 0,
«_h1_empty_pagesCount»: 0,
«_no_h1_pagesCount»: 0,
«_long_h1_pagesCount»: 1,
«_duplicate_h1_pagesCount»: 0,
«_h2_empty_pagesCount»: 0,
«_no_h2_pagesCount»: 0,
«_long_h2_pagesCount»: 2,
«_many_ext_links_pagesCount»: 10,
«_many_redirects_links»: 0,
«_int_links_no_title_count»: 0,
«_ext_links_no_title_count»: 40,
«_int_links_nofollow_count»: 343,
«_ext_links_nofollow_count»: 101,
«_no_intlinks_pagesCount»: 0,
«_ext_links_dofollow_count»: 68,
«_ext_links_400_count»: 0,
«_ext_links_500_count»: 0,
«_ext_links_all_count»: 169,
«_sitemap_links_all_count»: 44,
«_images_no_alt_count»: 18,
«_images_400_count»: «0»,
«_images_500_count»: «0»,
«_trailing_slashes»: 0,
«_frames_count»: 0,
«_flash_pages_count»: 0
},
«totals»: {
«total_pages»: 10,
«total_warnings»: 70,
«total_errors»: 22,
«total_passed»: 830
}
Параметры ответа
Имя | Описание |
audit_time | Время окончания аудита |
domain_data | Параметры, которые относятся к домену и к сайту в целом |
settings | Настройки (параметр может отсутствовать, если настройки не задавались отдельно для сайта) |
pages_data | Параметры проверки страниц |
totals | См. GET /audit/{site_id} |