Getting information about external links to the site
Returns examples of external links to site pages.
Request format
GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/links/external/samples/[?offset={offset}&limit={limit}]
Path parameters
Name | Required | Type | Default value | Description |
---|---|---|---|---|
user-id | Yes | int64 | User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user method. | |
host-id | Yes | host id | The site ID. To get it, use the GET /user/{user-id}/hosts method. |
Name | Required | Type | Default value | Description |
---|---|---|---|---|
user-id | Yes | int64 | User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user method. | |
host-id | Yes | host id | The site ID. To get it, use the GET /user/{user-id}/hosts method. |
Query parameters
Name | Required | Type | Default value | Description |
---|---|---|---|---|
offset | No | int32 | 0 | Offset in the list. The minimum value is 0. |
limit | No | int32 | 10 | Page size (1-100). |
Name | Required | Type | Default value | Description |
---|---|---|---|---|
offset | No | int32 | 0 | Offset in the list. The minimum value is 0. |
limit | No | int32 | 10 | Page size (1-100). |
Response format
Examples
{
"count": 1,
"links": [
{
"source_url": "explicit error message",
"destination_url": "explicit error message",
"discovery_date": "2016-01-01",
"source_last_access_date": "2016-01-01",
}, ...
]
}
<Data>
<count>1</count>
<link>
<source_url>explicit error message</source_url>
<destination_url>explicit error message</destination_url>
<discovery_date>2016-01-01</discovery_date>
<source_last_access_date>2016-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. |
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 | The ID of the user who issued the token differs from the one specified in the request. In the examples below, | |
404 | HOST_NOT_VERIFIED | Site management rights are not verified. |
Code | Reason | Description |
---|---|---|
200 | OK | |
403 | The ID of the user who issued the token differs from the one specified in the request. In the examples below, | |
404 | HOST_NOT_VERIFIED | Site management rights are not verified. |