Мониторинг важных страниц

Возвращает информацию об индексировании выбранных вами страниц сайта в Яндекс Вебмастере (Индексирование → Мониторинг важных страниц). Подробно см. в Помощи.

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

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

user-id

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

host-id

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

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

Пример

{
    "urls": [
        {
            "url": "https://example.com/",
            "update_date": "2019-09-05T00:00:00.000+03:00",
            "change_indicators": [],
            "indexing_status": {
                "status": "HTTP_2XX",
                "http_code": 200,
                "access_date": "2019-09-04T00:00:00.000+03:00"
            },
            "search_status": {
                "title": "some string",
                "description": "some string",
                "last_access": "2019-09-02T00:00:00.000+03:00",
                "excluded_url_status": NOTHING_FOUND,
                "bad_http_status": 500,
                "searchable": true,
                "target_url": "https://example.com/some/path?a=b"
            }
        }
    ]
}
<Data>
    <url>https://example.com</url>
    <update_date>2019-09-05T00:00:00.000+03:00</update_date>
    <change_indicators>...</change_indicators>
    <indexing_status>
        <status>HTTP_2XX</status>
        <http_code>200</http_code>
        <access_date>2019-09-04T00:00:00.000+03:00</access_date>
    </indexing_status>
    <search_status>
        <title>some string</title>
        <description>some string</description>
        <last_access>2019-09-02T00:00:00.000+03:00<last_access/>
        <excluded_url_status>NOTHING_FOUND</excluded_url_status>
        <bad_http_status>500</bad_http_status>
        <searchable>true</searchable>
        <target_url>https://example.com/some/path?a=b</target_url>
    <search_status/>
</Data>

Параметр

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

Тип

Описание

url

Да

url

Адрес страницы сайта.

update_date

Нет

datetime

Дата и время обновления информации о состоянии страницы.

change_indicators

Нет

string (ApiImportantUrlChangeIndicator)

Индикатор изменений. Содержит информацию о том, что изменилось по сравнению с предыдущей проверкой.

indexing_status

Нет

Информация об индексировании страницы роботом.

status

Да

string (IndexingStatusEnum)

Обобщенный статус HTTP-кода.

http_code

Нет

int32

HTTP-код.

access_date

Да

datetime

Дата обхода страницы.

search_status

Нет

Состояние страницы в результатах поиска.

title

Да

string

Заголовок страницы.

description

Нет

string

Содержимое метатега Description.

last_access

Да

datetime

Дата последнего обхода страницы до ее появления или исключения.

excluded_url_status

Нет

string (ApiExcludedUrlStatus)

Причина исключения страницы.

bad_http_status

Нет

int32

HTTP-код ответа страницы для статуса HTTP_ERROR.

searchable

Да

boolean

Признак присутствия страницы в результатах поиска. Возможные значения:

  • true — если страница участвует в поиске;

  • false — если страница не участвует в поиске.

target_url

Нет

url

Другой адрес страницы, по которому она известна роботу. Это может быть цель редиректа, канонический адрес или дублирующая страница.

Индикатор

Описание

INDEXING_HTTP_CODE

Изменился HTTP-кода ответа, который получил робот при обходе страницы.

SEARCH_STATUS

Изменился статус страницы в поиске (добавлена или удалена).

TITLE

Изменился заголовок страницы.

DESCRIPTION

Изменилось содержимое метатега Description.

Индикатор

Описание

HTTP_2XX

HTTP_3XX

HTTP_4XX

HTTP_5XX

Подробнее о статусах см. в Справке.

OTHER

Неподдерживаемый HTTP-код, ошибка соединения и др.

Индикатор

Описание

NOTHING_FOUND

Роботу неизвестно о странице или она длительное время была недоступна. Отправьте страницу на переобход.

HOST_ERROR

При обращении к сайту роботу не удалось установить соединение с сервером. Проверьте ответ сервера, убедитесь в отсутствии блокировки робота Яндекса на стороне провайдера. Сайт начнет индексироваться автоматически, если станет доступным для робота. О User agent роботов см. в Справке.

REDIRECT_NOTSEARCHABLE

Страница осуществляет перенаправление, при котором индексируется его цель (RedirectTarget). Проверьте индексирование страницы, на которую выполняется редирект.

HTTP_ERROR

При обращении к странице возникла ошибка «HTTP-ошибка». Проверьте ответ сервера. Если проблема актуальна, обратитесь к администратору своего сайта или сервера. Если страница уже доступна, отправьте ее на переобход.

NOT_CANONICAL

Страница проиндексирована по каноническому адресу, который был указан в атрибуте rel="canonical" в ее исходном коде. Исправьте или удалите атрибут, если он указан некорректно. Робот отследит изменения автоматически.

NOT_MAIN_MIRROR

Страница относится к неглавному адресу сайта, поэтому была исключена из поиска.

PARSER_ERROR

При обращении к странице роботу не удалось получить ее содержимое. Проверьте ответ сервера или наличие запрещающих HTML-элементов. Если проблема актуальна, обратитесь к администратору своего сайта или сервера. Если страница уже доступна, отправьте ее на переобход.

ROBOTS_HOST_ERROR

Индексирование сайта запрещено в файле robots.txt. Робот автоматически начнет посещать страницу, когда сайт станет доступен для индексирования.

ROBOTS_URL_ERROR

Индексирование страницы запрещено в robots.txt. Робот автоматически начнет посещать страницу, когда она станет доступной для индексирования.

DUPLICATE

Страница дублирует уже представленную в поиске страницу сайта. Подробнее см. в Справке.

LOW_QUALITY

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

CLEAN_PARAMS

Страница была исключена из поиска в результате обработки роботом директивы Clean-param. Чтобы страница индексировалась, измените robots.txt.

NO_INDEX

Страница исключена из-за метатега robots со значением noindex.

OTHER

У робота нет актуальных данных для страницы.

Проверьте ответ сервера или наличие запрещающих HTML-элементов.

Если страница недоступна для робота, обратитесь к администратору своего сайта или сервера. Если страница уже доступна, отправьте ее на переобход.

Коды ответа

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

Код

Причина

Описание

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](*error_code)>INVALID_USER_ID</error_code>
    <[available_user_id](*available_user_id)>1</available_user_id>
    <[error_message](*error_message)>Invalid user id. {user_id} should be used.</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](*error_code)>HOST_NOT_VERIFIED</error_code>  
  <[host_id](*host_id)>http:ya.ru:80</host_id>
  <[error_message](*error_message)>some string</error_message>
</Data>

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

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

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

Индикатор

Описание

INDEXING_HTTP_CODE

Изменился HTTP-кода ответа, который получил робот при обходе страницы.

SEARCH_STATUS

Изменился статус страницы в поиске (добавлена или удалена).

TITLE

Изменился заголовок страницы.

DESCRIPTION

Изменилось содержимое метатега Description.

Индикатор

Описание

HTTP_2XX

HTTP_3XX

HTTP_4XX

HTTP_5XX

Подробнее о статусах см. в Справке.

OTHER

Неподдерживаемый HTTP-код, ошибка соединения и др.

Индикатор

Описание

NOTHING_FOUND

Роботу неизвестно о странице или она длительное время была недоступна. Отправьте страницу на переобход.

HOST_ERROR

При обращении к сайту роботу не удалось установить соединение с сервером. Проверьте ответ сервера, убедитесь в отсутствии блокировки робота Яндекса на стороне провайдера. Сайт начнет индексироваться автоматически, если станет доступным для робота. О User agent роботов см. в Справке.

REDIRECT_NOTSEARCHABLE

Страница осуществляет перенаправление, при котором индексируется его цель (RedirectTarget). Проверьте индексирование страницы, на которую выполняется редирект.

HTTP_ERROR

При обращении к странице возникла ошибка «HTTP-ошибка». Проверьте ответ сервера. Если проблема актуальна, обратитесь к администратору своего сайта или сервера. Если страница уже доступна, отправьте ее на переобход.

NOT_CANONICAL

Страница проиндексирована по каноническому адресу, который был указан в атрибуте rel="canonical" в ее исходном коде. Исправьте или удалите атрибут, если он указан некорректно. Робот отследит изменения автоматически.

NOT_MAIN_MIRROR

Страница относится к неглавному адресу сайта, поэтому была исключена из поиска.

PARSER_ERROR

При обращении к странице роботу не удалось получить ее содержимое. Проверьте ответ сервера или наличие запрещающих HTML-элементов. Если проблема актуальна, обратитесь к администратору своего сайта или сервера. Если страница уже доступна, отправьте ее на переобход.

ROBOTS_HOST_ERROR

Индексирование сайта запрещено в файле robots.txt. Робот автоматически начнет посещать страницу, когда сайт станет доступен для индексирования.

ROBOTS_URL_ERROR

Индексирование страницы запрещено в robots.txt. Робот автоматически начнет посещать страницу, когда она станет доступной для индексирования.

DUPLICATE

Страница дублирует уже представленную в поиске страницу сайта. Подробнее см. в Справке.

LOW_QUALITY

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

CLEAN_PARAMS

Страница была исключена из поиска в результате обработки роботом директивы Clean-param. Чтобы страница индексировалась, измените robots.txt.

NO_INDEX

Страница исключена из-за метатега robots со значением noindex.

OTHER

У робота нет актуальных данных для страницы.

Проверьте ответ сервера или наличие запрещающих HTML-элементов.

Если страница недоступна для робота, обратитесь к администратору своего сайта или сервера. Если страница уже доступна, отправьте ее на переобход.