Getting the site indexing history

Returns the history of site indexing by Yandex robots.

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

Request format

GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/indexing-history/?indexing_indicator={indexing_indicator}[&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
indexing_indicator Yes ApiIndexingIndicator List of indicators to show the history for.
date_from No datetime Start date of the period.
date_to No datetime End date of the period.

Indexing indicators (ApiIndexingIndicator)

Indicator Description
SEARCHABLE Pages in the search.
DOWNLOADED Downloaded pages.
DOWNLOADED_2XX Pages downloaded with a 2XX code.
DOWNLOADED_3XX Pages downloaded with a 3XX code.
DOWNLOADED_4XX Pages downloaded with a 4XX code.
DOWNLOADED_5XX Pages downloaded with a 5XX code.
FAILED_TO_DOWNLOAD Failed to download.
EXCLUDED Excluded pages.
EXCLUDED_DISALLOWED_BY_USER Excluded at the request of the resource owner (4XX codes or prohibited in robots.txt).
EXCLUDED_SITE_ERROR Excluded due to a site error.
EXCLUDED_NOT_SUPPORTED Excluded as not supported by the Yandex robots.

Response format

Examples

{
  "indicators": {
    "SEARCHABLE": [
      {
        "date": "2016-01-01T00:00:00,000+0300",
        "value": 1
      }, ...
    ], ...
  }
}
Name Required Type Description
SEARCHABLE Yes ApiIndexingIndicator Indicator.
date Yes datetime Date.
value Yes int64 The indicator value.

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