Viewing example pages in search

Returns the URLs of pages included in the search results (maximum 50,000).

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

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/search-urls/in-search/samples/?[&offset=0&limit=100]

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.

Query parameters

Name Required Type Default value Description
offset No int32 The list offset. The minimum value is 0.
limit No int32 Page size (1-100).

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

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