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

Response format

Examples

JSON

XML

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

<Data>  
  <count>1</count>  
  <sample>   
    <status>HTTP_2XX</status>    
    <http_code>200</http_code>    
    <url>http://example.com/some/path?a=b</url>    
    <access_date>2016-01-01T00:00:00,000+0300</access_date>
  </sample>  
</Data>

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)

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