Getting the history of changes in the number of external links to the site

Returns the history of changes in the number of external links to the site.

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/links/external/history
  ? (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.

indicator*

Indicates the number of external links (APIExternalLinksIndicator).

* Required

Response format

Examples

{
  "indicators": {
    "LINKS_TOTAL_COUNT": [
      {
        "date": "2019-01-01T00:00:00,000+0300",
        "value": 1
      }
    ]
  }
}
<Data>
    <indicators>
        <LINKS_TOTAL_COUNT>
            <date>2019-01-01T00:00:00,000+0300</date>
            <value>1</value>
        </LINKS_TOTAL_COUNT>
    </indicators>
</Data>

Name

Required

Type

Description

LINKS_TOTAL_COUNT

Yes

APIExternalLinksIndicator

Indicates the number of external links.

date

Yes

Date

The date when the link was detected.

value

Yes

string

The indicator value.

Indicator

Description

LINKS_TOTAL_COUNT

The total number of known external links to the host.

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>

*Required

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.

Indicates the number of external links (APIExternalLinksIndicator).

Indicator

Description

LINKS_TOTAL_COUNT

The total number of known external links to the host.

Description

Error code.

Description

ID of the user who allowed access.

Description

ID of the requested site.

Description

Error message.

Required

Yes

Type

Date

Description

The date when the link was detected.

Required

Yes

Type

string

Description

The indicator value.