Просмотр примеров загруженных страниц

Возвращает список проиндексированных страниц сайта — до 50 000 URL.

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

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

user-id

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

host-id

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

offset

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

limit

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

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

Примеры

{
  "count": 1,
  "samples": [
    {
      "status": "HTTP_2XX",
      "http_code": 200,
      "url": "http://example.com/some/path?a=b",
      "access_date": "2016-01-01T00:00:00,000+0300"
    }
  ]
}
<Data>
  <count>1</count>
  <sample>
    <status>HTTP_2XX</status>
    <http_code>200</http_code>
    <url>http://example.com/some/path?a=b</url>
    <access_date>2016-01-01T00:00:00,000+0300</access_date>
  </sample>
</Data>

Имя

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

Тип

Описание

count

Да

int32

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

sample | samples

Да

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

status

Да

string (IndexingStatusEnum)

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

http_code

Нет

int32

HTTP-код.

url

Да

string

URL проиндексированной страницы.

access_date

Да

datetime

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

Статусы HTTP-кода, полученные роботом при индексировании сайта (IndexingStatusEnum)

Индикатор

Описание

HTTP_2XX

HTTP_3XX

HTTP_4XX

HTTP_5XX

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

OTHER

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

Коды ответа

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

Код

Причина

Описание

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.

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

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

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

Да

Тип

int32

Описание

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

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

Да

Тип

Описание

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

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

Да

Тип

string (IndexingStatusEnum)

Описание

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

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

Нет

Тип

int32

Описание

HTTP-код.

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

Да

Тип

string

Описание

URL проиндексированной страницы.

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

Да

Тип

datetime

Описание

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