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

Внимание. Вы открыли документацию API версии 3.2. Яндекс Вебмастер перестал поддерживать версию 3.2 и ниже со второго полугодия 2020 г. Рекомендуем использовать API версии 4.1.

Возвращает примеры внешних ссылок на страницы сайта.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

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

GET https://api.webmaster.yandex.net/v3.2/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.
Имя Обязательный Тип Значение по умолчанию Описание
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).
Имя Обязательный Тип Значение по умолчанию Описание
offset Нет int32 0 Смещение в списке. Минимальное значение — 0.
limit Нет int32 10 Размер страницы (1-100).

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

Примеры

{
  "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 Да url URL страницы назначения (НА которую ведет ссылка).
discovery date Да date Дата обнаружения ссылки.
source_last_access_date Да date Дата последнего посещения роботом страницы назначения ссылки.
Имя Обязательный Тип Описание
count Да int64 Количество доступных примеров ссылок.
source_url Да string URL страницы, содержащей ссылку на сайт.
destination_url Да url URL страницы назначения (НА которую ведет ссылка).
discovery date Да date Дата обнаружения ссылки.
source_last_access_date Да date Дата последнего посещения роботом страницы назначения ссылки.

Коды ответа

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

Код Причина Описание
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."
}
404 HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some 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."
}
404 HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}