Получение статистики сайта

Внимание. Вы открыли документацию API версии 3.2. Яндекс Вебмастер перестал поддерживать версию 3.2 и ниже со второго полугодия 2020 г. Рекомендуем использовать API версии 4.1.

Возвращает общую информацию об индексировании сайта.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

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

GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/summary/

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /user.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts.
Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /user.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts.

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

Пример

{
  "sqi": 1,
  "excluded_pages_count": 1,
  "searchable_pages_count": 1,
  "site_problems": {
    "FATAL": 1
  }
}
Параметр Обязательный Тип Описание
sqi Да int32 Индекс качества сайта.
excluded_pages_count Да int64 Количество исключенных страниц.
searchable_pages_count Да int64 Количество страниц в поиске.
site_problems Да int32 Количество найденных на сайте проблем, сгруппированных по степени серьезности, см. Серьезность ошибки.
Параметр Обязательный Тип Описание
sqi Да int32 Индекс качества сайта.
excluded_pages_count Да int64 Количество исключенных страниц.
searchable_pages_count Да int64 Количество страниц в поиске.
site_problems Да int32 Количество найденных на сайте проблем, сгруппированных по степени серьезности, см. Серьезность ошибки.

Категории проблем на сайте (SiteProblemSeverityEnum)

Индикатор Описание Примечание
FATAL Фатальные проблемы. Проверяется соединение с сервером, доступность сайта для индексирования, безопасность и соблюдение правил Яндекса.

Могут вести к исключению отдельных страниц или всего сайта из результатов поиска.

Рекомендуем отслеживать и исправлять их в кратчайшие сроки.
CRITICAL Критичные проблемы. Проверяется наличие и корректность SSL-сертификата, количество неработающих внутренних ссылок и время ответа сервера.
POSSIBLE_PROBLEM Возможные проблемы. Проверяется корректность файлов Sitemap и robots.txt, настройки отображения несуществующих файлов, количество страниц-дублей, наличие редиректов, раздражающей рекламы и пр. Могут влиять на качество и скорость индексирования страниц сайта.
RECOMMENDATION Рекомендации. Как правило, касаются улучшения представления сайта в результатах поиска. Позволяют улучшить представление сайта в результатах поиска.
Индикатор Описание Примечание
FATAL Фатальные проблемы. Проверяется соединение с сервером, доступность сайта для индексирования, безопасность и соблюдение правил Яндекса.

Могут вести к исключению отдельных страниц или всего сайта из результатов поиска.

Рекомендуем отслеживать и исправлять их в кратчайшие сроки.
CRITICAL Критичные проблемы. Проверяется наличие и корректность SSL-сертификата, количество неработающих внутренних ссылок и время ответа сервера.
POSSIBLE_PROBLEM Возможные проблемы. Проверяется корректность файлов Sitemap и robots.txt, настройки отображения несуществующих файлов, количество страниц-дублей, наличие редиректов, раздражающей рекламы и пр. Могут влиять на качество и скорость индексирования страниц сайта.
RECOMMENDATION Рекомендации. Как правило, касаются улучшения представления сайта в результатах поиска. Позволяют улучшить представление сайта в результатах поиска.

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код Причина Описание
200 OK
403

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."
}
404 HOST_NOT_FOUND

Сайт отсутствует в списке сайтов пользователя.

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
HOST_NOT_LOADED
Данные о сайте еще не загружены в Яндекс Вебмастер.
{
  "error_code": "HOST_NOT_LOADED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
Код Причина Описание
200 OK
403

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."
}
404 HOST_NOT_FOUND

Сайт отсутствует в списке сайтов пользователя.

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
HOST_NOT_LOADED
Данные о сайте еще не загружены в Яндекс Вебмастер.
{
  "error_code": "HOST_NOT_LOADED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}