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.

Request format

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

Response format

Examples

JSON

XML

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

<Data>
    <sitemap_id>c7-fe:80-c0</sitemap_id>
    <sitemap_url>some url</sitemap_url>
    <last_access_date>2016-01-01T00:00:00,000+0300</last_access_date>
    <errors_count>1</errors_count>
    <urls_count>1</urls_count>
    <children_count>1</children_count>
    <source>ROBOTS_TXT</source>
    ...
    <sitemap_type>SITEMAP</sitemap_type>
</Data>

Source of the Sitemap file (ApiSitemapSource)

Type of Sitemap file (ApiSitemapType)

Response codes

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

{   
    "error_code": "INVALID_USER_ID",   
    "available_user_id": 1,   
    "error_message": "Invalid user id. {user_id} should be used." 
}

<Data>     
    <error_code>INVALID_USER_ID</error_code>     
    <available_user_id>1</available_user_id>     
    <error_message>Invalid user id. {user_id} should be used.</error_message> 
</Data>

{   
    "error_code": "HOST_NOT_VERIFIED",   
    "host_id": "http:ya.ru:80",   
    "error_message": "some string"
}

<Data>   
    <error_code>HOST_NOT_VERIFIED</error_code>     
    <host_id>http:ya.ru:80</host_id>   
    <error_message>some string</error_message> 
</Data>

{   
    "error_code": "HOST_NOT_LOADED",   
    "host_id": "http:ya.ru:80",   
    "error_message": "some string"
}

<Data>   
    <error_code>HOST_NOT_LOADED</error_code>     
    <host_id>http:ya.ru:80</host_id>   
    <error_message>some string</error_message>
</Data>

{   
    "error_code": "SITEMAP_NOT_FOUND",   
    "host_id": "http:ya.ru:80",   
    "sitemap_id": "c7-fe:80-c0",   
    "error_message": "some string"
}

<Data>   
    <error_code>SITEMAP_NOT_FOUND</error_code>    
    <host_id>http:ya.ru:80</host_id>     
    <sitemap_id>c7-fe:80-c0</sitemap_id>     
    <error_message>some string</error_message> 
</Data>

Related information

• Error codes and statuses