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

NameRequiredTypeDefault valueDescription
user-idYesint64The user ID.
host-idYeshost idSite ID.

Query arguments

NameRequiredTypeDefault valueDescription
indexing_indicatorYesApiIndexingIndicator collectionList of indicators to show the history for.
date_fromNoyyyy-MM-ddTHH:mm:ss,sssZStart of the data range to display.
date_toNoyyyy-MM-ddTHH:mm:ss,sssZEnd of the data range to display.

Indexing indicators (ApiIndexingIndicator)

IndicatorDescription
SEARCHABLEPages available on search.
DOWNLOADEDVisited pages.
DOWNLOADED_2XXVisited pages with a 2xx code.
DOWNLOADED_3XXVisited pages with a 3xx code.
DOWNLOADED_4XXVisited pages with a 4xx code.
DOWNLOADED_5XXVisited pages with a 5xx code.
FAILED_TO_DOWNLOADLoading failed.
EXCLUDEDExcluded pages.
EXCLUDED_DISALLOWED_BY_USERPages excluded by the resource owner's choice (4xx codes or disallows in robots.txt).
EXCLUDED_SITE_ERRORExclusions due to an error on the site.
EXCLUDED_NOT_SUPPORTEDExclusions 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
      }, ...
    ], ...
  }
}
NameRequiredTypeDescription
SEARCHABLEYesApiIndexingIndicatorIndicator.
DateYesyyyy-MM-ddTHH:mm:ss,sssZDate.
valueYesint64Indicator 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."
}
ParameterDescription
error_codeError code.
available_user_idID of the user who allowed access.
error_messageError message.

404 Not Found

  • HOST_NOT_INDEXED error

    {
      "error_code": "HOST_NOT_INDEXED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    ParameterDescription
    error_codeThe site hasn't been indexed yet.
    host_idSite ID.
    error_messageError message.
  • HOST_NOT_LOADED error

    {
      "error_code": "HOST_NOT_LOADED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    ParameterDescription
    error_codeThe site data hasn't been loaded to Yandex.Webmaster yet.
    host_idSite ID.
    error_messageError message.
  • HOST_NOT_VERIFIED error

    {
      "error_code": "HOST_NOT_VERIFIED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    ParameterDescription
    error_codeThe site hasn't been added to the list of sites, or the user hasn't verified site management rights.
    host_idSite ID.
    error_messageError message.