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)>]
user-id | Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method. |
host-id | Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method. |
user-id | Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method. |
host-id | Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method. |
parent_id | The parent Sitemap ID. |
limit | Page size (1-100). Default value: 10. |
from | Get Sitemap files starting after the specified one (not including it). |
parent_id | The parent Sitemap ID. |
limit | Page size (1-100). Default value: 10. |
from | Get Sitemap files starting after the specified one (not including it). |
Response format
If successful, the server returns 200 OK and the list of the site's Sitemap files.
Examples
{
"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 (ApiExplicitVerificationType ) | Type of the Sitemap file. |
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 (ApiExplicitVerificationType ) | 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. |
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. |
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 | The ID of the user who issued the token differs from the one specified in the request. In the examples below, | |
404 | HOST_NOT_VERIFIED | Site management rights are not verified. |
Code | Reason | Description |
---|---|---|
200 | OK | |
403 | The ID of the user who issued the token differs from the one specified in the request. In the examples below, | |
404 | HOST_NOT_VERIFIED | Site management rights are not verified. |