Getting the history of changes to an important page

Returns information about changes to the specified page (selected in Yandex.Webmaster on the Indexing → Monitoring important pages page). For more information, see this Help section.

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

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/important-urls/history
 ? (url=<url>)
Path parameters
user-idType: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.
host-idType: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.
Query parameters
url *The URL of the page you want to get information about, encoded according to the RFC 3986 standard.

*  Required

Response format

Example

{
    "history": [
        {
            "url": "https://example.com/",
            "update_date": "2019-09-05T00:00:00.000+03:00",
            "change_indicators": [],
            "indexing_status": {
                "status": "HTTP_2XX",
                "http_code": 200,
                "access_date": "2019-09-04T00:00:00.000+03:00"
            },
            "search_status": {
                "title": "some string",
                "description": "some string",
                "last_access": "2019-09-02T00:00:00.000+03:00",
                "excluded_url_status": NOTHING_FOUND,
                "bad_http_status": 500,
                "searchable": true,
                "target_url": "https://example.com/some/path?a=b"
            }
        }
    ]
}
Parameter Required Type Description
url Yes url Site page URL.
update_date No datetime Date and time the page status information was updated.
change_indicators No string (ApiImportantUrlChangeIndicator) Indicator of changes. Contains information about what changed from the previous check.
indexing_status No Information about the page indexing by the robot.
status Yes string (IndexingStatusEnum) Generalized status of the HTTP code.
http_code No int32 HTTP code.
access_date Yes datetime Date the page was crawled.
search_status No The state of the page in the search results.
title Yes string Page heading.
description No string The Description meta tag content.
last_access Yes datetime The date when the page was last crawled before it appeared or was excluded.
excluded_url_status No string (ApiExcludedUrlStatus) The reason the page was excluded.
bad_http_status No int32 The page's HTTP response code for the HTTP_ERROR status.
searchable Yes boolean Indicates whether the page is present in the search results. Possible values:
  • true — If the page is included in the search.
  • false — If the page isn't included in the search.
target_url No url Another address of the page that the robot is aware of. This could be a redirect target, canonical address or a duplicate page.

Changes to important pages in the search (ApiImportantUrlChangeIndicator)

Indicator Description
INDEXING_HTTP_CODE The HTTP response code received by the robot when crawling the page changed.
SEARCH_STATUS The page status in the search changed (it was added or removed).
TITLE The page title changed.
DESCRIPTION The Description meta tag content changed.

HTTP status codes received by the robot during indexing (IndexingStatusEnum)

Indicator Description

HTTP_2XX

HTTP_3XX

HTTP_4XX

HTTP_5XX

For more information about statuses, see the help section.
OTHER Unsupported HTTP code, connection error, or other error.

Reasons for excluding the page from search results (ApiExcludedUrlStatus)

Indicator Description
NOTHING_FOUND The robot doesn't know about the page, or it was unavailable for a long time. Submit the page for reindexing.
HOST_ERROR When trying to access the site, the robot could not connect to the server. Check the server response and make sure that the Yandex robot isn't blocked by the hosting provider. The site is indexed automatically when it becomes available for the robot. For information about the user agent robots, see the help section.
REDIRECT_NOTSEARCHABLE The page redirects to another page. The target page is indexed (RedirectTarget). Check the indexing of the target page.
HTTP_ERROR An error occurred when accessing the “HTTP error” page. Check the server response. If the problem persists, contact your site administrator or the server administrator. If the page is already available, submit it for reindexing.
NOT_CANONICAL The page is indexed by the canonical URL specified in the rel="canonical" attribute in its source code. Correct or delete the attribute if it is specified incorrectly. The robot will track the changes automatically.
NOT_MAIN_MIRROR The page belongs to a secondary site mirror, so it was excluded from the search.
PARSER_ERROR When trying to access the page, the robot couldn't get its content. Check the server response or the presence of prohibiting HTML elements. If the problem persists, contact your site administrator or the server administrator. If the page is already available, send it for reindexing.
ROBOTS_HOST_ERROR Site indexing is prohibited in the robots.txt file. The robot will automatically start crawling the page when the site becomes available for indexing.
ROBOTS_URL_ERROR Page indexing is prohibited in the robots.txt file. The robot will automatically crawl the page when it becomes available for indexing.
DUPLICATE The page duplicates a site page that is already in the search. For more information, see the help section.
LOW_QUALITY The page has been removed from search results due to low quality as determined by a special algorithm. If the algorithm finds the page relevant to users' search queries, it will appear in the search automatically.
CLEAN_PARAMS The page was excluded from the search after the robot processed the Clean-param directive. To get the page indexed, edit the robots.txt file.
NO_INDEX The page is excluded because the robots meta tag has the noindex value.
OTHER

The robot does not have updated data for the page.

Check the server response or the presence of prohibiting HTML elements.

If the page can't be accessed by the robot, contact the administrator of your site or server. If the page is already available, send it for reindexing.

Response codes

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

Code Reason Description
200 OK
400

INVALID_URL

Wrong URL was passed.

{
  "error_code": "INVALID_URL",
  "error_message": "some string"
}