Getting the history of pages added to and removed from search results

Returns the number of pages that appeared in search and were removed from search results in a given period. By default, data for the current day is returned.

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/search-urls/events/history
  ? [date_from=<datetime>]
  & [date_to=<datetime>]

Response format

Examples

JSON

XML

{
  "indicators": {
    "APPEARED_IN_SEARCH": [
      {
        "date": "2016-01-01T00:00:00,000+0300",
        "value": 1
      }
    ]
  }
}

<Data>  
  <indicators>
    <APPEARED_IN_SEARCH>      
      <date>2016-01-01T00:00:00,000+0300</date>      
      <value>1</value>
    </APPEARED_IN_SEARCH>    
  </indicators>
</Data>

Name	Required	Type	Description
APPEARED_IN_SEARCH	Yes		The page status (ApiSearchEventEnum).
date	Yes	datetime	Date and time when the search output was updated.
value	Yes	int64	Number of pages.

Site page status in search results (ApiSearchEventEnum)

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>

{   
    "error_code": "HOST_NOT_INDEXED", //errorCode.    
    "host_id": "http:ya.ru:80", //id хоста. host id.    
    "error_message": "some string" //Error message.  
}

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

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

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

Related information

• Error codes and statuses