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.

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

date_from

The start date of the range. If omitted, data is returned for the current day.

date_to

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

<Data>
    <indicators>
        <DISALLOWED_BY_USER>
            <date>2019-04-15T00:00:00.000+03:00</date>
            <value>116</value>
        </DISALLOWED_BY_USER>
    </indicators>
</Data>

Name

Required

Type

Description

DISALLOWED_BY_USER

No

ApiInternalLinksBrokenIndicator

The reason the link doesn't work.

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

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

{   
    "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>

Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.

Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.

The start date of the range. If omitted, data is returned for the current day.

The end date of the range. If omitted, data is returned for the current day.

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.

Description

Error code.

Description

ID of the user who allowed access.

Description

Error message.

Description

ID of the requested site.

Previous
Getting information about broken internal links on the site
Next
Getting information about external links to the site