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

Returns the history of changes in the number of broken internal links on the site.

  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/history
 ? [date_from=<datetime>]
 & [date_to=<datetime>]
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.
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.
date_fromThe start date of the range. If omitted, data is returned for the current day.
date_toThe end date of the range. If omitted, data is returned for the current day.
date_fromThe start date of the range. If omitted, data is returned for the current day.
date_toThe end date of the range. If omitted, data is returned for the current day.

Response format

Examples

{
    "indicators": {
        "DISALLOWED_BY_USER": [
            {
                "date": "2019-04-15T00:00:00.000+03:00",
                "value": 116
            }
        ]
    }
}
Name Required Type Description
DISALLOWED_BY_USER No ApiInternalLinksBrokenIndicator The reason the link doesn't work.
Name Required Type Description
DISALLOWED_BY_USER No ApiInternalLinksBrokenIndicator The reason the link doesn't work.

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.
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 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"
}
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"
}