Viewing examples of downloaded pages

Returns the list of indexed site pages (maximum 50,000 URLs).

  1. Request format
  2. Response format
  3. Response codes

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/indexing/samples
 ? [offset=<int32>]
 & [limit=<int32>]
Path parameters
user-idType: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.
host-idType: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.
Query parameters
offsetThe list offset. The minimum value is 0.
limitPage size (1-100).

Response format

Examples

{
  "count": 1,
  "samples": [
    {
      "status": "HTTP_2XX",
      "http_code": 200,
      "url": "http://example.com/some/path?a=b",
      "access_date": "2016-01-01T00:00:00,000+0300"
    }
  ]
}
Name Required Type Description
count Yes int32 Total number of available examples.
sample | samples Yes Sample pages.
status Yes string (IndexingStatusEnum) Generalized status of the HTTP code.
http_code No int32 HTTP code.
url Yes string The indexed page URL.
access_date Yes datetime Date the page was crawled.

HTTP status codes received by the robot during indexing (IndexingStatusEnum)

Indicator Description

HTTP_2XX

HTTP_3XX

HTTP_4XX

HTTP_5XX

For more information about statuses, see the help section.
OTHER Unsupported HTTP code, connection error, or other error.

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