Viewing examples of downloaded pages
Returns the list of indexed site pages (maximum 50,000 URLs).
Request format
GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/indexing/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. |
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 | The list offset. The minimum value is 0. |
limit | Page size (1-100). Default value: 50. |
offset | The list offset. The minimum value is 0. |
limit | Page size (1-100). Default value: 50. |
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. |
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. |
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 | 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. |