SEO-проекты · token

audit Аудит: результаты техпроверок и история robots.txt

Группа отдаёт результаты технического аудита проекта — то, что видно на вкладке «Аудит»: индексацию в Яндексе и Google, коды ответа страниц, скорость загрузки, зеркала, поддомены, ссылочный профиль и историю изменений robots.txt. Методы синхронные и ничего не запускают — отдают результаты последних плановых техпроверок.

Адрес
/projects/api/v1/audit/<метод>, /projects/api/v1/service-robotstxt/get
Режим
синхронный
Лимиты
вызов не тратит

Все результаты аудита

GET /projects/api/v1/audit/get

Последний результат каждой техпроверки, отмеченной в настройках проекта, одним объектом — те же данные, из которых строится вкладка «Аудит».

Формат ответа служебный: это внутренняя структура страницы аудита, без обёртки status/result, и она меняется вместе с интерфейсом. Для интеграций надёжнее audit/pages, audit/getsummary и audit/robots.

Параметры query

  • token string обязательный
    Ключ API из настроек аккаунта — тот же, что key у методов инструментов.
  • project_id int обязательный
    ID проекта. Виден в адресе страницы проекта и в ответе projects/get.

Ответ

Ключ верхнего уровня — слаг проверки. Блоки есть, только если проверка включена и хотя бы раз отработала.

  • tools_dates object
    Дата последнего результата каждой проверки, ДД.ММ.ГГГГ, ключ — слаг.
  • fast-audit object
    Быстрый аудит: индексация в Яндексе и Google и её изменение, SEO-теги, срок регистрации домена.
  • server-response object
    Коды ответа проверенных страниц.
  • speedtest object
    Скорость загрузки и размер документов.
  • indexed-domains, poisk-zerkal, struktura, seo-tags, analiz-saitov, affiliation object
    Поддомены, зеркала, структура сайта, SEO-теги, SSL и прочие показатели, аффилированность.
  • links object
    Ссылочный профиль: распределения анкоров и данные для графиков (строки JSON).
  • global-warning, server-response-warning bool
    Есть ли проблемы в аудите в целом и в кодах ответа.

Индексация страниц в Яндексе и Google

GET /projects/api/v1/audit/pages

Число страниц сайта в индексе Яндекса и Google по последнему быстрому аудиту и изменение с прошлой проверки. Нужен результат быстрого аудита — он входит в технические проверки проекта.

Параметры query

  • token string обязательный
    Ключ API из настроек аккаунта — тот же, что key у методов инструментов.
  • project_id int обязательный
    ID проекта. Виден в адресе страницы проекта и в ответе projects/get.

Ответ

Объект без обёртки status/result. Вместо числа может прийти NotIndex — значение не удалось получить.

  • index_yandex int|string
    Страниц в индексе Яндекса.
  • index_yandex_site int|string
    Должно быть число страниц по оператору site:, но сейчас дублирует index_yandex.
  • delta_yandex, delta_yandex_site int|null
    Изменение с прошлой проверки; null, если не изменилось.
  • index_google, index_google_inurl int|string
    Страниц в индексе Google: по site: и по inurl:.
  • delta_google, delta_google_inurl int|null
    Изменение с прошлой проверки; null, если не изменилось.
  • date string
    Дата проверки, ДД.ММ.ГГГГ.

Сводка предупреждений

GET /projects/api/v1/audit/getsummary

Есть ли проблемы по двум проверкам: поиск поддоменов (indexed-domains — предупреждение, если поддоменов не найдено) и коды ответа страниц (server-response — предупреждение, если хоть одна страница ответила не 200). Остальные проверки в сводку не входят.

Параметры query

  • token string обязательный
    Ключ API из настроек аккаунта — тот же, что key у методов инструментов.
  • project_id int обязательный
    ID проекта. Виден в адресе страницы проекта и в ответе projects/get.

Ответ

Массив без обёртки status/result; пустой, если обе проверки не включены или ещё не отработали.

  • [].ID string
    Слаг проверки: indexed-domains или server-response.
  • [].title string
    Всегда пустая строка.
  • [].warning bool
    Есть ли проблема.
  • [].date string
    Дата проверки, ДД.ММ.ГГГГ.

История robots.txt

GET /projects/api/v1/audit/robots

Все сохранённые версии robots.txt проекта, отличия каждой от предыдущей и URL, закрытые от индексации по последней проверке. Новая версия сохраняется, только когда файл изменился.

Параметры query

  • token string обязательный
    Ключ API из настроек аккаунта — тот же, что key у методов инструментов.
  • project_id int обязательный
    ID проекта. Виден в адресе страницы проекта и в ответе projects/get.

Ответ

  • result.robots_warning bool
    Последняя версия отличается от предыдущей.
  • result.robots_txt[] object
    Сохранённые версии robots.txt, от новой к старой.
    Вложенные поля
    • id string
      ID версии.
    • project_id string
      ID проекта.
    • robots string
      Текст файла целиком.
    • dt string
      Когда версия сохранена, ГГГГ-ММ-ДД ЧЧ:ММ:СС.
  • result.robots_compare object
    Отличия каждой версии от предыдущей, ключ — ID версии. Названия перевёрнуты: old — строки, которые в этой версии появились, new — строки, которые из неё удалены. У самой старой версии оба списка пустые.
  • result.robots_urls_list[] object
    До 100 URL, закрытых в robots.txt, по последней проверке: url, правило rule, дата dt.

Последние изменения robots.txt (служебный)

GET /projects/api/v1/service-robotstxt/get

Облегчённый вариант audit/robots: только последние limit версий и их отличия, без списка закрытых URL, плюс имя и домен проекта.

Метод служебный, сделан для внешнего сервиса: формат ответа не такой, как у остальных методов группы, — без code и msg, а ошибка доступа приходит текстом в message.

Параметры query

  • token string обязательный
    Ключ API из настроек аккаунта — тот же, что key у методов инструментов.
  • project_id int обязательный
    ID проекта. Виден в адресе страницы проекта и в ответе projects/get.
  • limit int
    Сколько последних версий отдать.
    По умолчанию 3

Ответ

  • id string
    project_id из запроса как есть.
  • name, domain string
    Название и домен проекта.
  • result.warnings bool
    Последняя версия отличается от предыдущей.
  • result.tools_result.robots_txt[] object
    Версии файла, как в audit/robots.
  • result.tools_result.robots_compare object
    Отличия версий; old — добавленные строки, new — удалённые.
  • status string
    success или 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-формы.

Обратная связь и помощь
Если у вас есть идеи, как улучшить данный инструмент или остались вопросы по работе с ним, напишите в нашу службу поддержки, мы обязательно вам поможем.