Getting the list of Sitemap files

Returns a list of Sitemap files detected by Yandex robots.

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/sitemaps
  ? [parent_id=<sitemap id (string)>]
  & [limit=<int32>]
  & [from=<sitemap id (string)>]

Response format

If successful, the server returns 200 OK and the list of the site's Sitemap files.

Examples

JSON

XML

{
  "sitemaps": [
    {
      "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>
        <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>
    </sitemap>
    ...
</Data>

Name	Required	Type	Description
sitemap_id	Yes	string	ID of the Sitemap file.
sitemap_url	Yes	string	The Sitemap URL.
last_access_date	No	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	string (ApiSitemapSource)	The sources that led the robot to this file.
sitemap_type	Yes	string (ApiSitemapType)	Type of the Sitemap file.

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>

Related information

• Error codes and statuses