Getting information about the Sitemap added by the user
Returns detailed information about a Sitemap file added by the user, 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}/user-added-sitemaps/{sitemap-id}
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. |
sitemap-id | Type: sitemap id (string). Sitemap file ID. |
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. |
sitemap-id | Type: sitemap id (string). Sitemap file ID. |
Response format
Examples
{
"sitemap_id": "c7-fe:80-c0",
"sitemap_url": "some url",
"added_date": "2016-01-01T00:00:00,000+0300"
}
<Data>
<sitemap_id>c7-fe:80-c0</sitemap_id>
<sitemap_url>some url</sitemap_url>
<added_date>2016-01-01T00:00:00,000+0300</added_date>
</Data>
Name | Required | Type | Description |
---|---|---|---|
sitemap_id | Yes | string | The sitemap file ID. |
sitemap_url | Yes | string | The sitemap file URL. |
added_date | Yes | datetime | Date the file was last uploaded. |
Name | Required | Type | Description |
---|---|---|---|
sitemap_id | Yes | string | The sitemap file ID. |
sitemap_url | Yes | string | The sitemap file URL. |
added_date | Yes | datetime | Date the file was last uploaded. |
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. |
SITEMAP_NOT_ADDED | The Sitemap file is missing. |
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. |
SITEMAP_NOT_ADDED | The Sitemap file is missing. |