Getting information about external links to the site

Returns examples of external links to site pages.

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/links/external/samples
  ? [offset=<int32>]
  & [limit=<int32>]

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.

Response format

Examples

{
  "count": 1,
  "links": [
    {
      "source_url": "https://other-example.com/page/",
      "destination_url": "https://example.com/page1/",
      "discovery_date": "2019-01-01",
      "source_last_access_date": "2019-01-01",
    }, ...
  ]
}

<Data>
    <count>1</count>
    <link>
        <source_url>https://other-example.com/page/</source_url>
        <destination_url>https://example.com/page1/</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.

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

Offset in the list. The minimum value is 0. Default value: 0.

Page size (1-100). Default value: 10.

Required

Yes

Type

string

Description

The URL of the page that contains the link to the site.

Required

Yes

Type

url

Description

The target page URL (where the link points to).

Required

Yes

Type

Date

Description

The date when the link was detected.

Required

Yes

Type

Date

Description

The date when the robot last visited the target page.

Description

Error code.

Description

Error message.

Description

ID of the user who allowed access.

Description

ID of the requested site.

Required

Yes

Type

int64

Description

The number of example links available.

Previous
Getting the history of changes in the number of broken internal links on the site
Next
Getting the history of changes in the number of external links to the site