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.

  1. Request format
  2. Response format
  3. Response codes

Request format


Path parameters

Name Required Type Default value Description
user-id Yes int64 User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user method.
host-id Yes host id The site ID. To get it, use the GET /user/{user-id}/hosts method.
sitemap-id Yes sitemap id Sitemap file ID.

Response format

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


  "sitemap_id": "c7-fe:80-c0",
  "sitemap_url": "explicit error message",
  "added_date": "2016-01-01T00:00:00,000+0300"
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


The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
Site management rights are not verified.
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "",
  "error_message": "some string"
The Sitemap file is missing.
  "error_code": "SITEMAP_NOT_ADDED",
  "host_id": "",
  "sitemap_id": "c7-fe:80-c0",
  "error_message": "some string"