Getting information about external links to the site

Description

Gets examples of external links to site pages.

Request format

Send a GET request to the operation address for the links/external/samples resource for the user's site:

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

Path parameters

NameRequiredTypeDefault valueDescription
user-idYesint64The user ID.
host-idYeshost idSite ID.

Query arguments

NameRequiredTypeDefault valueDescription
OffsetNoint320Offset in the list. The minimum value is 0.
LimitNoint3210Page size (1-100).

Response format

If successful, the server returns 200 OK and a list of external links:

Samples

{
  "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",
    }, ...
  ]
}
NameRequiredTypeDescription
countYesint64The number of link examples available.
source_urlYesstringThe URL of a page containing a link to the site.
destination_urlYesstringThe URL of the destination page that the link goes to.
discovery dateYesyyyy-MM-ddTHH:mm:ss,sssZThe date when the link was detected.
source_last_access_dateYesyyyy-MM-ddTHH:mm:ss,sssZThe date when the robot last visited the link destination page.

Errors

403 Forbidden

The user ID for the token doesn't match the one specified in the request. In the examples below, {user_id} is the correct uid for the owner of the OAuth token.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
ParameterDescription
error_codeError code.
available_user_idID of the user who allowed access.
error_messageError message.

404 Not Found

The site isn't in the list of the user's sites, or rights to the site haven't been verified.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
ParameterDescription
error_codeError code.
host_idThe ID of the requested site.
error_messageError message.