Getting the site indexing history

Description

Gets the history of indexing the site by Yandex robots.

Request format

Send a GET request to the operation address for the indexing-history resource for the user's site.

GET https://api.webmaster.yandex.net/v3/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 The user ID.
host-id Yes host id Site ID.

Query arguments

Name Required Type Default value Description
indexing_indicator Yes ApiIndexingIndicator collection List of indicators to show the history for.
date_from No yyyy-MM-ddTHH:mm:ss,sssZ Start of the data range to display.
date_to No yyyy-MM-ddTHH:mm:ss,sssZ End of the data range to display.

Indexing indicators (ApiIndexingIndicator)

Indicator Description
SEARCHABLE Pages available on search.
DOWNLOADED Visited pages.
DOWNLOADED_2XX Visited pages with a 2xx code.
DOWNLOADED_3XX Visited pages with a 3xx code.
DOWNLOADED_4XX Visited pages with a 4xx code.
DOWNLOADED_5XX Visited pages with a 5xx code.
FAILED_TO_DOWNLOAD Loading failed.
EXCLUDED Excluded pages.
EXCLUDED_DISALLOWED_BY_USER Pages excluded by the resource owner's choice (4xx codes or disallows in robots.txt).
EXCLUDED_SITE_ERROR Exclusions due to an error on the site.
EXCLUDED_NOT_SUPPORTED Exclusions of pages not supported by Yandex robots.

Response format

If successful, the server returns 200 OK and the histories of the requested indicators:

Samples

{
  "indicators": {
    "SEARCHABLE": [
      {
        "date": "2016-01-01T00:00:00,000+0300",
        "value": 1
      }, ...
    ], ...
  }
}
Name Required Type Description
SEARCHABLE Yes ApiIndexingIndicator Indicator.
Date Yes yyyy-MM-ddTHH:mm:ss,sssZ Date.
value Yes int64 Indicator value.

Errors

403 Forbidden

The user ID for the token doesn't match the one specified in the request. In the examples below, {user_id} is the correct uid for the owner of the OAuth token.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Parameter Description
error_code Error code.
available_user_id ID of the user who allowed access.
error_message Error message.

404 Not Found

  • HOST_NOT_INDEXED error

    {
      "error_code": "HOST_NOT_INDEXED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Parameter Description
    error_code The site hasn't been indexed yet.
    host_id Site ID.
    error_message Error message.
  • HOST_NOT_LOADED error

    {
      "error_code": "HOST_NOT_LOADED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Parameter Description
    error_code The site data hasn't been loaded to Yandex.Webmaster yet.
    host_id Site ID.
    error_message Error message.
  • HOST_NOT_VERIFIED error

    {
      "error_code": "HOST_NOT_VERIFIED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Parameter Description
    error_code The site hasn't been added to the list of sites, or the user hasn't verified site management rights.
    host_id Site ID.
    error_message Error message.