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.

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

Request format


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
date_from No datetime Start date of the period.
date_to No datetime End date of the period.

Response format


  "indicators": {
        "date": "2016-01-01T00:00:00,000+0300",
        "value": 1
Name Required Type Description
APPEARED_IN_SEARCH Yes ApiSearchEventEnum Page status.
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)

Indicator Description
APPEARED_IN_SEARCH The page appeared in search results.
REMOVED_FROM_SEARCH The page was removed from search results.

Response codes

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

Code Reason Description
200 OK


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."
Site management rights are not verified.
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "",
  "error_message": "some string"
The site isn't indexed yet.
  "error_code": "HOST_NOT_INDEXED", //errorCode. 
  "host_id": "", //id хоста. host id. 
  "error_message": "some string" //Error message. 
The site data isn't uploaded to Yandex.Webmaster yet.
  "error_code": "HOST_NOT_LOADED",
  "host_id": "",
  "error_message": "some string"