Viewing example pages in search
Returns the URLs of pages included in the search results (maximum 50,000).
Request format
GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/search-urls/in-search/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": [
{
"url": "http://example.com/some/path?a=b",
"last_access": "2016-01-01T00:00:00,000+0300",
"title": "some string"
}
]
}
<Data>
<count>1</count>
<sample>
<url>http://example.com/some/path?a=b</url>
<last_access>2016-01-01T00:00:00,000+0300</last_access>
<title>some string</title>
</sample>
</Data>
Name | Required | Type | Description |
---|---|---|---|
count | Yes | int32 | Total number of available examples. |
sample | samples | Yes | Sample pages. | |
url | Yes | url | The page URL. |
last_access | Yes | datetime | The date of the page version in search. |
title | Yes | string | Page heading. |
Name | Required | Type | Description |
---|---|---|---|
count | Yes | int32 | Total number of available examples. |
sample | samples | Yes | Sample pages. | |
url | Yes | url | The page URL. |
last_access | Yes | datetime | The date of the page version in search. |
title | Yes | string | Page heading. |
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. |