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.

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>]

`user-id`	Type: `int64`. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.
`host-id`	Type: `host id (string)`. The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.
`offset`	Offset in the list. The minimum value is 0. Default value: 0.
`limit`	Page 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.

Internal link indicators (ApiInternalLinksBrokenIndicator)

Indicator	Description
`SITE_ERROR`	The total number of known external links to the site.
`DISALLOWED_BY_USER`	The page doesn't exist or is prohibited from indexing.
`UNSUPPORTED_BY_ROBOT`	Not supported by the main Search indexing robot.

Response format

Examples

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>

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. 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	Site management rights are 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>`

Error codes and statuses

Was the article helpful?

Site diagnostics

Getting the history of changes in the number of broken internal links on the site