Диагностика

Возвращает информацию об ошибках Турбо‑страниц.

Для обращения к ресурсу необходимо использовать токен с доступом для получения информации о статусе индексирования.

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/diagnostics
user-idИдентификатор пользователя. Значение можно получить с помощью операции GET /v4/user.
host-id
Идентификатор сайта. Имеет формат scheme:host:port, где
  • scheme — протокол http или https.
  • host — адрес сайта с www или без.
  • port — порт для подключения. Для протокола http — 80, для https — 443.

Например: https:example.com:443 или http:www.example.com:80.

Также идентификатор сайта можно получить с помощью операции GET /user/{user-id}/hosts.

user-idИдентификатор пользователя. Значение можно получить с помощью операции GET /v4/user.
host-id
Идентификатор сайта. Имеет формат scheme:host:port, где
  • scheme — протокол http или https.
  • host — адрес сайта с www или без.
  • port — порт для подключения. Для протокола http — 80, для https — 443.

Например: https:example.com:443 или http:www.example.com:80.

Также идентификатор сайта можно получить с помощью операции GET /user/{user-id}/hosts.

Формат ответа

Сервис возвращает данные в формате JSON (по умолчанию) или XML. Чтобы получить XML-ответ, передайте в запросе HTTP-заголовок Accept: application/xml.

{
  "problems": {
    "NO_SITEMAPS": {
      "severity": "FATAL",
      "state": "PRESENT",
      "last_state_update": "2016-01-01T00:00:00,000+0300"
    }
  }
}
NO_SITEMAPS
Проблема. Возможные значения:
  • TURBO_FEED_ERROR — найдены ошибки при обработке RSS-канала для Турбо‑страниц.
  • TURBO_FEED_WARNING — найдены предупреждения при обработке RSS-канала для Турбо‑страниц.
  • TURBO_FEED_BAN — некоторые RSS-каналы отклонены.
  • TURBO_DOCUMENT_BAN — показ некоторых Турбо‑страниц сайта отключен.
  • TURBO_HOST_BAN — показ Турбо‑страниц сайта отключен.
  • TURBO_INSUFFICIENT_CLICKS_SHARE — низкое покрытие Турбо‑страницами поискового трафика.
severity
Категория проблемы. Возможные значения:
  • FATAL — фатальная проблема. Сервис проверяет содержимое RSS-канала на максимальное соответствие контенту страниц сайта. Может вести к запрету показа Турбо‑страниц. Рекомендуем отслеживать и исправлять их в кратчайшие сроки.
  • CRITICAL — критичная проблема. Связана с обновлением RSS-канала. Может вести к запрету показа Турбо‑страниц. Рекомендуем отслеживать и исправлять их в кратчайшие сроки.
  • POSSIBLE_PROBLEM — предупреждение. Сервис проверяет содержимое элемента item. Для элементов item с ошибками не сформируются Турбо‑страницы.
state
Состояние проблемы. Возможные значения:
  • PRESETS — присутствует на сайте.
  • ABSENT — отсутствует.
  • UNDEFINED — недостаточно данных для определения наличия проблем.
last_state_update
Дата последнего изменения состояния проблемы.

Чтобы узнать подробности о состоянии, перейдите в Вебмастер на страницу Турбо‑страницы для контентных сайтов → Диагностика. Также вы можете настроить уведомления, чтобы получать сообщения о диагностике на электронную почту.

Коды ответа

Код Описание
200 OK Запрос выполнен успешно.
403 Forbidden
INVALID_USER_ID
ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.
Пример ответа
{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Скопировано
error_code
Код ошибки.
available_user_id
ID пользователя, от имени которого разрешен доступ.
error_message
Сообщение об ошибке.
404 Not Found
HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
Пример ответа
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
Скопировано
error_code
Код ошибки.
host_id
ID запрошенного сайта.
error_message
Сообщение об ошибке.
Код Описание
200 OK Запрос выполнен успешно.
403 Forbidden
INVALID_USER_ID
ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.
Пример ответа
{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Скопировано
error_code
Код ошибки.
available_user_id
ID пользователя, от имени которого разрешен доступ.
error_message
Сообщение об ошибке.
404 Not Found
HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
Пример ответа
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
Скопировано
error_code
Код ошибки.
host_id
ID запрошенного сайта.
error_message
Сообщение об ошибке.