Getting the history of changes to the number of pages in search

Returns the number of pages in search results for a specific time period. By default, data for the current day is returned.

  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/history/?[&date_from={date_from}&date_to={date_to}]

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

Examples

{
  "history": [
    {
      "date": "2016-01-01T00:00:00,000+0300",
      "value": 1
    }
  ]
}
Name Required Type Description
date Yes datetime Date and time when the search output was updated.
value Yes int64 Number of pages in search.

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"
}
HOST_NOT_INDEXED
The site isn't indexed yet.
{
  "error_code": "HOST_NOT_INDEXED", //errorCode. 
  "host_id": "http:ya.ru:80", //id хоста. host id. 
  "error_message": "some string" //Error message. 
}
HOST_NOT_LOADED
The site data isn't uploaded to Yandex.Webmaster yet.
{
  "error_code": "HOST_NOT_LOADED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}