Getting information about broken internal links on the site

Returns examples of broken internal links on the site. The list of link examples is based on the data from the Yandex robot. The link is considered broken if there is an error in the URL of the page, the URL of the page changed or the page doesn't exist.

  1. Request format
  2. Response format
  3. Response codes

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/links/internal/broken/samples
 ? [offset=<int32>]
 & [limit=<int32>]
 & [indicator=<string>]
Path parameters
user-idType: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.
host-idType: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.
Query parameters
offsetOffset in the list. The minimum value is 0. Default value: 0.
limitPage size (1-100). Default value: 10.
indicator

The broken link indicator — the reason the link doesn't work (ApiInternalLinksBrokenIndicator). You can specify multiple indicators. For example, indicator=SITE_ERROR&indicator=DISALLOWED_BY_USER.

If the indicator is omitted, the report will contain all link types.

Response format

Examples

{
  "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",
    }, ...
  ]
}
Name Required Type Description
count Yes int64 The number of example links available.
source_url Yes string The URL of the page that contains the link to the site.
destination_url Yes url The target page URL (where the link points to).
discovery_date Yes Date The date when the link was detected.
source_last_access_date Yes Date The date when the robot last visited the target page.

Response codes

To view the response structure in detail, click the reason.

Code Reason Description
200 OK
403

INVALID_USER_ID

The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Site management rights are not verified.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}