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

Возвращает примеры неработающих внутренних ссылок сайта. Список примеров ссылок формируется на основе данных робота Яндекса. Ссылка может считаться неработающей, если допущена ошибка в адресе (URL) страницы, URL страницы изменился или страница не существует.
  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/links/internal/broken/samples
 ? [offset=<int32>]
 & [limit=<int32>]
 & [indicator=<string>]
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.
offsetСмещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.
limitРазмер страницы (1-100). Значение по умолчанию: 10.
indicator

Индикатор неработающей ссылки — причина, по которой ссылка не работает (ApiInternalLinksBrokenIndicator). Можно указать несколько индикаторов. Например, indicator=SITE_ERROR&indicator=DISALLOWED_BY_USER.

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

offsetСмещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.
limitРазмер страницы (1-100). Значение по умолчанию: 10.
indicator

Индикатор неработающей ссылки — причина, по которой ссылка не работает (ApiInternalLinksBrokenIndicator). Можно указать несколько индикаторов. Например, indicator=SITE_ERROR&indicator=DISALLOWED_BY_USER.

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

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

Примеры

{
  "count": 1,
  "links": [
    {
      "source_url": "http://example.com/page1/",
      "destination_url": "https://example.com/page2/",
      "discovery_date": "2019-01-01",
      "source_last_access_date": "2019-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"
}