Просмотр примеров появившихся и удаленных страниц из поиска

Возвращает URL страниц, появившихся в поиске или исключенных из него — до 50 000.

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/search-urls/events/samples
  ? [offset=<int32>]
  & [limit=<int32>]

user-id

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

host-id

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

offset

Смещение списка. Минимальное значение — 0.

limit

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

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

Примеры

{
  "count": 1,
  "samples": [
    {
      "url": "http://example.com/some/path?a=b",
      "title": "some string",
      "event_date": "2016-01-01T00:00:00,000+0300",
      "last_access": "2016-01-01T00:00:00,000+0300",
      "event": "APPEARED_IN_SEARCH",
      "excluded_url_status": "NOTHING_FOUND",
      "bad_http_status": 500,
      "target_url": "http://example.com/some/path?a=b"
    }
  ]
}
<Data>
  <count>1</count>
  <sample>
    <url>http://example.com/some/path?a=b</url>
    <title>some string</title>
    <event_date>2016-01-01T00:00:00,000+0300</event_date>
    <last_access>2016-01-01T00:00:00,000+0300</last_access>
    <event>APPEARED_IN_SEARCH</event>
    <excluded_url_status>NOTHING_FOUND</excluded_url_status>
    <bad_http_status>500</bad_http_status>
    <target_url>http://example.com/some/path?a=b</target_url>
  </sample>
</Data>

Имя

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

Тип

Описание

count

Да

int32

Общее количество доступных примеров.

sample | samples

Да

Примеры страниц.

url

Да

url

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

title

Да

string

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

event_date

Да

datetime

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

last_access

Да

datetime

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

event

Да

string (ApiSearchEventEnum)

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

excluded_url_status

Нет

string (ApiExcludedUrlStatus)

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

bad_http_status

Нет
int32

int32

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

target_url

Нет

url

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

Индикатор

Описание

APPEARED_IN_SEARCH

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

REMOVED_FROM_SEARCH

Страница исключена из результатов поиска.

Индикатор

Описание

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>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_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 пользователя, от имени которого разрешен доступ.

Описание

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

Описание

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

Описание

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

Описание

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

Описание

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

Описание

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

Смещение списка. Минимальное значение — 0.

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

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

Да

Тип

int32

Описание

Общее количество доступных примеров.

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

Да

Тип

Описание

Примеры страниц.

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

Да

Тип

url

Описание

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

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

Да

Тип

string

Описание

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

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

Да

Тип

datetime

Описание

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

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

Да

Тип

datetime

Описание

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

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

Да

Тип

string (ApiSearchEventEnum)

Описание

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

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

Нет

Тип

string (ApiExcludedUrlStatus)

Описание

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

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

Нет
int32

Тип

int32

Описание

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

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

Нет

Тип

url

Описание

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