Getting information about the Sitemap file

Returns detailed information about the Sitemap file, including the file type, date and method used for uploading the file to Yandex.Webmaster, the date the service processed the file, the number of URLs in the file and the number and type of errors found.

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

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/sitemaps/?sitemap_id={sitemap_id}

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
sitemap_id Yes sitemap id Sitemap file ID.

Response format

Examples

{
  "sitemap_id": "c7-fe:80-c0",
  "sitemap_url": "some url",
  "last_access_date": "2016-01-01T00:00:00,000+0300",
  "errors_count": 1,
  "urls_count": 1,
  "children_count": 1,
  "sources": [
    "ROBOTS_TXT", ...
  ],
  "sitemap_type": "SITEMAP"
}
Name Required Type Description
sitemap_id Yes string The Sitemap file ID.
sitemap_url Yes string The Sitemap URL.
last_access_date Yes datetime Date the file was last uploaded.
errors_count Yes int32 The number of errors in the file.
urls_count Yes int64 The number of links in the file.
children_count Yes int32 The number of child Sitemap files.
source Yes ApiSitemapSource The sources that led the robot to this file.
sitemap_type Yes ApiSitemapType Type of the Sitemap file.

Source of the Sitemap file (ApiSitemapSource)

Source Description
ROBOTS_TXT Sitemap is specified in the site's robots.txt file.
WEBMASTER The user added the Sitemap in Yandex.Webmaster.
INDEX_SITEMAP Sitemap found in another (index) Sitemap file.

Type of Sitemap file (ApiSitemapType)

Type Description
SITEMAP Normal Sitemap file that contains the URLs of site pages.
INDEX_SITEMAP The Sitemap index file that contains the URLs of other Sitemap files.

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_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"
}
SITEMAP_NOT_FOUND
The Sitemap for the site wasn't found.
{
  "error_code": "SITEMAP_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "sitemap_id": "c7-fe:80-c0",
  "error_message": "some string"
}