Getting a list of tasks for reindexing

Returns a list of tasks for reindexing site pages.

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

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/recrawl/queue/?[&offset=0&limit=100&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
offset No int32 0 Offset in the list.
limit No int32 50 Page size. The minimum value is 1.
date_to No datetime Start date of the period.
date_from No datetime End date of the period.

Response format

Examples

{
  "tasks": [
    {
      "task_id": "c7fe80c0-36e3-11e6-8b2d-df96aa592c0a",
      "url": "http://example.com/some/path?a=b",
      "added_time": "2016-01-01T00:00:00,000+0300",
      "state": "IN_PROGRESS"
    }
  ]
}
Name Required Type Description
task_id Yes string ID of the reindexing task.
url Yes string The URL of the page sent for reindexing.
added_time No datetime Date the reindexing request was created.
state Yes RecrawlStatusEnum The status of the reindexing request.

Reindexing request status (RecrawlStatusEnum)

Indicator Description
IN_PROGRESS The request is being processed.
DONE The robot crawled the URL
FAILED The robot failed to crawl the page. Make sure it is accessible to the robot and the server responds fast enough.

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