audit Аудит: результаты техпроверок и история robots.txt
Группа отдаёт результаты технического аудита проекта — то, что видно на вкладке «Аудит»: индексацию в Яндексе и Google, коды ответа страниц, скорость загрузки, зеркала, поддомены, ссылочный профиль и историю изменений robots.txt. Методы синхронные и ничего не запускают — отдают результаты последних плановых техпроверок.
- Адрес
/projects/api/v1/audit/<метод>,/projects/api/v1/service-robotstxt/get- Режим
- синхронный
- Лимиты
- вызов не тратит
Все результаты аудита
/projects/api/v1/audit/get
Последний результат каждой техпроверки, отмеченной в настройках проекта, одним объектом — те же данные, из которых строится вкладка «Аудит».
Формат ответа служебный: это внутренняя структура страницы аудита, без обёртки status/result, и она меняется вместе с интерфейсом. Для интеграций надёжнее audit/pages, audit/getsummary и audit/robots.
Параметры query
-
tokenstring обязательныйКлюч API из настроек аккаунта — тот же, чтоkeyу методов инструментов. -
project_idint обязательныйID проекта. Виден в адресе страницы проекта и в ответе projects/get.
Ответ
Ключ верхнего уровня — слаг проверки. Блоки есть, только если проверка включена и хотя бы раз отработала.
-
tools_datesobjectДата последнего результата каждой проверки,ДД.ММ.ГГГГ, ключ — слаг. -
fast-auditobjectБыстрый аудит: индексация в Яндексе и Google и её изменение, SEO-теги, срок регистрации домена. -
server-responseobjectКоды ответа проверенных страниц. -
speedtestobjectСкорость загрузки и размер документов. -
indexed-domains, poisk-zerkal, struktura, seo-tags, analiz-saitov, affiliationobjectПоддомены, зеркала, структура сайта, SEO-теги, SSL и прочие показатели, аффилированность. -
linksobjectСсылочный профиль: распределения анкоров и данные для графиков (строки JSON). -
global-warning, server-response-warningboolЕсть ли проблемы в аудите в целом и в кодах ответа.
Индексация страниц в Яндексе и Google
/projects/api/v1/audit/pages
Число страниц сайта в индексе Яндекса и Google по последнему быстрому аудиту и изменение с прошлой проверки. Нужен результат быстрого аудита — он входит в технические проверки проекта.
Параметры query
-
tokenstring обязательныйКлюч API из настроек аккаунта — тот же, чтоkeyу методов инструментов. -
project_idint обязательныйID проекта. Виден в адресе страницы проекта и в ответе projects/get.
Ответ
Объект без обёртки status/result. Вместо числа может прийти NotIndex — значение не удалось получить.
-
index_yandexint|stringСтраниц в индексе Яндекса. -
index_yandex_siteint|stringДолжно быть число страниц по операторуsite:, но сейчас дублируетindex_yandex. -
delta_yandex, delta_yandex_siteint|nullИзменение с прошлой проверки;null, если не изменилось. -
index_google, index_google_inurlint|stringСтраниц в индексе Google: поsite:и поinurl:. -
delta_google, delta_google_inurlint|nullИзменение с прошлой проверки;null, если не изменилось. -
datestringДата проверки,ДД.ММ.ГГГГ.
Сводка предупреждений
/projects/api/v1/audit/getsummary
Есть ли проблемы по двум проверкам: поиск поддоменов (indexed-domains — предупреждение, если поддоменов не найдено) и коды ответа страниц (server-response — предупреждение, если хоть одна страница ответила не 200). Остальные проверки в сводку не входят.
Параметры query
-
tokenstring обязательныйКлюч API из настроек аккаунта — тот же, чтоkeyу методов инструментов. -
project_idint обязательныйID проекта. Виден в адресе страницы проекта и в ответе projects/get.
Ответ
Массив без обёртки status/result; пустой, если обе проверки не включены или ещё не отработали.
-
[].IDstringСлаг проверки:indexed-domainsилиserver-response. -
[].titlestringВсегда пустая строка. -
[].warningboolЕсть ли проблема. -
[].datestringДата проверки,ДД.ММ.ГГГГ.
История robots.txt
/projects/api/v1/audit/robots
Все сохранённые версии robots.txt проекта, отличия каждой от предыдущей и URL, закрытые от индексации по последней проверке. Новая версия сохраняется, только когда файл изменился.
Параметры query
-
tokenstring обязательныйКлюч API из настроек аккаунта — тот же, чтоkeyу методов инструментов. -
project_idint обязательныйID проекта. Виден в адресе страницы проекта и в ответе projects/get.
Ответ
-
result.robots_warningboolПоследняя версия отличается от предыдущей. -
result.robots_txt[]objectСохранённые версии robots.txt, от новой к старой.Вложенные поля
-
idstringID версии. -
project_idstringID проекта. -
robotsstringТекст файла целиком. -
dtstringКогда версия сохранена,ГГГГ-ММ-ДД ЧЧ:ММ:СС.
-
-
result.robots_compareobjectОтличия каждой версии от предыдущей, ключ — ID версии. Названия перевёрнуты:old— строки, которые в этой версии появились,new— строки, которые из неё удалены. У самой старой версии оба списка пустые. -
result.robots_urls_list[]objectДо 100 URL, закрытых в robots.txt, по последней проверке:url, правилоrule, датаdt.
Последние изменения robots.txt (служебный)
/projects/api/v1/service-robotstxt/get
Облегчённый вариант audit/robots: только последние limit версий и их отличия, без списка закрытых URL, плюс имя и домен проекта.
Метод служебный, сделан для внешнего сервиса: формат ответа не такой, как у остальных методов группы, — без code и msg, а ошибка доступа приходит текстом в message.
Параметры query
-
tokenstring обязательныйКлюч API из настроек аккаунта — тот же, чтоkeyу методов инструментов. -
project_idint обязательныйID проекта. Виден в адресе страницы проекта и в ответе projects/get. -
limitintСколько последних версий отдать.
Ответ
-
idstringproject_idиз запроса как есть. -
name, domainstringНазвание и домен проекта. -
result.warningsboolПоследняя версия отличается от предыдущей. -
result.tools_result.robots_txt[]objectВерсии файла, как в audit/robots. -
result.tools_result.robots_compareobjectОтличия версий;old— добавленные строки,new— удалённые. -
statusstringsuccessилиerror.
Ошибки
| Код | Сообщение | Когда |
|---|---|---|
50 |
access error |
Токен не передан, не найден, или у его владельца нет доступа к проекту. |
666 |
something is going wrong |
audit/pages: у проекта нет результата быстрого аудита — проверка не включена в настройках проекта или ещё не отработала. |
— |
Access denied |
service-robotstxt/get: нет доступа к проекту. Приходит как {"status": "error", "message": "Access denied", "name": null, "domain": null}. |
Откуда данные
Методы читают сохранённые результаты плановых техпроверок проекта: что проверять и как часто, задаётся в настройках проекта, в разделе технических проверок. Если проверка выключена, её блока в ответе нет. Сами вызовы ничего не перепроверяют и лимитов не тратят.
Формат ответа
Обёртку status/code/msg/result использует только audit/robots. audit/get, audit/pages и audit/getsummary при успехе отдают данные без обёртки, service-robotstxt/get — в своём формате. Так сложилось исторически, формат сохранён ради совместимости. Параметры читаются из query-строки; service-robotstxt/get принимает их и из тела POST-формы.