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

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

Внимание

Убедитесь, что в настройках приложения, которое вы регистрировали на Яндекс OAuth для работы с API Вебмастера, добавлен доступ Получение информации о внешних ссылках на сайт (webmaster:hostinfo).

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

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.
`offset`	Смещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.
`limit`	Количество записей (1-100). Значение по умолчанию: 10.
`indicator`	Индикатор неработающей ссылки — причина, по которой ссылка не работает (ApiInternalLinksBrokenIndicator). Можно указать несколько индикаторов. Например, `indicator=SITE_ERROR&indicator=DISALLOWED_BY_USER`. Если индикатор не указан, отчет будет содержать все типы ссылок.

Индикатор	Описание
`SITE_ERROR`	Общее количество известных внешних ссылок на сайт.
`DISALLOWED_BY_USER`	Страница не существует или ее индексирование запрещено.
`UNSUPPORTED_BY_ROBOT`	Не поддерживаются основным индексирующим роботом Поиска.

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

Примеры

JSON

XML

{
  "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",
    }, ...
  ]
}

<Data>
    <count>1</count>
    <link>
        <source_url>https://example.com/page1/</source_url>
        <destination_url>https://example.com/page2/</destination_url>
        <discovery_date>2019-01-01</discovery_date>
        <source_last_access_date>2019-01-01</source_last_access_date>
    </link>
    ...
</Data>

Имя	Обязательный	Тип	Описание
`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-токена. JSON XML `{ "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	Не подтверждены права на управление сайтом. JSON XML `{ "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>`

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

Коды ошибок и статусы

Была ли статья полезна?

Диагностика сайта

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