Получение информации о внешних ссылках на сайт

Описание

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

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

Отправьте GET-запрос на адрес операции links/external/samples ресурса сайта пользователя:

GET https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/{host-id}/links/external/samples/[?offset={offset}&limit={limit}]

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user/.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts/.

Query-параметры

Имя Обязательный Тип Значение по умолчанию Описание
offset Нет int32 0 Смещение в списке. Минимальное значение - 0.
limit Нет int32 10 Размер страницы (1-100).

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

В случае успеха сервер возвращает 200 OK и список внешних ссылок:

Примеры

{
  "count": 1,
  "links": [
    {
      "source_url": "explicit error message",
      "destination_url": "explicit error message",
      "discovery_date": "2016-01-01",
      "source_last_access_date": "2016-01-01",
    }, ...
  ]
}
Имя Обязательный Тип Описание
count Да int64 Количество доступных примеров ссылок.
source_url Да string URL страницы, содержащей ссылку на сайт.
destination_url Да string URL страницы назначения (НА которую ведет ссылка).
discovery date Да yyyy-MM-ddTHH:mm:ss,sssZ Дата обнаружения ссылки.
source_last_access_date Да yyyy-MM-ddTHH:mm:ss,sssZ Дата последнего посещения роботом страницы назначения ссылки.

Ошибки

403 Forbidden

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена. Проверьте OAuth-токен.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Параметр Описание
error_code Код ошибки.
available_user_id ID пользователя, от имени которого разрешен доступ.
error_message Сообщение об ошибке.

404 Not Found

Сайт отсутствует в списке сайтов пользователя или на него не подтверждены права.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
Параметр Описание
error_code Код ошибки.
host_id ID запрошенного сайта.
error_message Сообщение об ошибке.