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

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

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

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

user-id

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

host-id

Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

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

Пример

{
  "sqi": 1,
  "excluded_pages_count": 1,
  "searchable_pages_count": 1,
  "site_problems": {
    "FATAL": 1
  }
}
<Data>
    <sqi>1</sqi>
    <excluded_pages_count>1</excluded_pages_count>
    <searchable_pages_count>1</searchable_pages_count>
    <site_problems>
        <FATAL>1</FATAL>
    </site_problems>
</Data>

Параметр

Обязательный

Тип

Описание

sqi

Да

int32

Индекс качества сайта.

excluded_pages_count

Да

int64

Количество исключенных страниц.

searchable_pages_count

Да

int64

Количество страниц в поиске.

site_problems

Да

int32

Количество найденных на сайте проблем, сгруппированных по степени серьезности, см. Серьезность ошибки.

Индикатор

Описание

Примечание

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."
}
<Data>
    <error_code>INVALID_USER_ID</error_code>
    <available_user_id>1</available_user_id>
    <error_message>Invalid user id. {user_id} should be used.</error_message>
</Data>

404

HOST_NOT_FOUND

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

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
<Data>
    <error_code>HOST_NOT_FOUND</error_code>
    <host_id>http:ya.ru:80</host_id>
    <error_message>explicit error message</error_message>
</Data>

404

HOST_NOT_LOADED

Данные о сайте еще не загружены в Яндекс Вебмастер.

{
  "error_code": "HOST_NOT_LOADED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
<Data>
  <error_code>HOST_NOT_LOADED</error_code>  
  <host_id>http:ya.ru:80</host_id>
  <error_message>some string</error_message>
</Data>

404

HOST_NOT_VERIFIED

Не подтверждены права на управление сайтом.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
<Data>
  <error_code>HOST_NOT_VERIFIED</error_code>  
  <host_id>http:ya.ru:80</host_id>
  <error_message>some string</error_message>
</Data>

Узнайте больше

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

Обязательный параметр

Смещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.

Количество записей (1-100). Значение по умолчанию: 10.

Описание

Код ошибки.

Описание

Сообщение об ошибке.

Описание

Значение.

Описание

Поле.

Описание

ID запрошенного сайта.

Описание

ID сайта.

Описание

Признак подтверждения сайта.

Описание

ID файла Sitemap.

Описание

Список поддерживаемых типов контента.

Описание

Лимит на количество добавленных сайтов.

Описание

Лимит количества фидов.

Описание

Лимит количества добавленных фидов.

Описание

ID пользователя, от имени которого разрешен доступ.

Описание

Дата и время, до которого адрес доступен для создания задачи.

Описание

Список поддерживаемых типов контента.

Описание

Список поддерживаемых типов кодировки.

Описание

Максимальная длина.

Описание

Минимальная длина.

Описание

Доступное количество запросов в сутки.

Индикатор

Описание

Примечание

FATAL

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

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

CRITICAL

Критичные проблемы. Проверяется наличие и корректность SSL-сертификата, количество неработающих внутренних ссылок и время ответа сервера.

POSSIBLE_PROBLEM

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

Могут влиять на качество и скорость индексирования страниц сайта.

RECOMMENDATION

Рекомендации. Как правило, касаются улучшения представления сайта в результатах поиска.

Позволяют улучшить представление сайта в результатах поиска.