Просмотр примеров страниц в поиске

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

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/search-urls/in-search/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",
      "last_access": "2016-01-01T00:00:00,000+0300",
      "title": "some string"
    }
  ]
}
<Data>
  <count>1</count>
  <sample>
    <url>http://example.com/some/path?a=b</url>
    <last_access>2016-01-01T00:00:00,000+0300</last_access>
    <title>some string</title>
  </sample>
</Data>

Имя

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

Тип

Описание

count

Да

int32

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

sample | samples

Да

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

url

Да

url

URL страницы.

last_access

Да

datetime

Дата версии страницы в поиске.

title

Да

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

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