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

Response format

Examples

JSON

XML

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

Response codes

To view the response structure in detail, click the reason.

{   
    "error_code": "INVALID_USER_ID",   
    "available_user_id": 1,   
    "error_message": "Invalid user id. {user_id} should be used." 
}

<Data>     
    <error_code>INVALID_USER_ID</error_code>     
    <available_user_id>1</available_user_id>     
    <error_message>Invalid user id. {user_id} should be used.</error_message> 
</Data>

{   
    "error_code": "HOST_NOT_VERIFIED",   
    "host_id": "http:ya.ru:80",   
    "error_message": "some string"
}

<Data>   
    <error_code>HOST_NOT_VERIFIED</error_code>     
    <host_id>http:ya.ru:80</host_id>   
    <error_message>some string</error_message> 
</Data>

Related information

• Error codes and statuses