Getting information about a sitemap file

Description

Gets detailed information about the sitemap file, including file type, date, method used for uploading the file to Yandex.Webmaster, date the file was processed by the service, number of URLs contained in the file, and number and type of errors found.

Request format

Send a GET request to the operation address for the site's sitemaps resource:

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

Path parameters

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

Query arguments

NameRequiredTypeDefault valueDescription
sitemap_idYessitemap idID of the sitemap file.

Response format

If successful, the server returns 200 OK and information about the requested sitemap.

Samples

{
  "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"
}
NameRequiredTypeDescription
sitemap_idYesstringID of the sitemap file.
sitemap_urlYesstringURL of the sitemap file.
last_access_dateYesyyyy-MM-ddTHH:mm:ss,sssZThe date when the file was last visited.
errors_countYesint32The number of errors in the file.
urls_countYesint64The number of URLs in the file.
children_countYesint32The number of child sitemaps.
SourceYesApiSitemapSourceThe sources that led the robot to this file.
sitemap_typeYesApiSitemapTypeThe type of sitemap file.

Sitemap source (ApiSitemapSource)

SourceDescription
ROBOTS_TXTThe sitemap is specified in the robots.txt file on the site.
WEBMASTERThe user added the sitemap in Yandex.Webmaster.
INDEX_SITEMAPThe sitemap was found in another (indexed) sitemap file.

Type of sitemap file (ApiSitemapType)

TypeDescription
SITEMAPA normal sitemap file containing the URLs of site pages.
INDEX_SITEMAPA sitemap index containing the URLs of other sitemaps.

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

  • SITEMAP_NOT_FOUND error

    {
      "error_code": "SITEMAP_NOT_FOUND",
      "host_id": "http:ya.ru:80",
      "sitemap_id": "c7-fe:80-c0",
      "error_message": "explicit error message"
    }
    ParameterDescription
    error_codeThe site hasn't been indexed yet.
    host_idSite ID.
    sitemap_idID of the sitemap file.
    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.