Getting information about a sitemap added by the user

Description

Gets 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, date the file was processed by the service, number of URLs contained in the file, and number and type of errors found.

Request format

Send a GET request to the address of the sitemap file uploaded by the user:

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

Path parameters

NameRequiredTypeDefault valueDescription
user-idYesint64The user ID.
host-idYeshost idSite ID.
sitemap-idYessitemap idID of the sitemap file.

Response format

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

Samples

{
  "sitemap_id": "c7-fe:80-c0",
  "sitemap_url": "explicit error message",
  "added_date": "2016-01-01T00:00:00,000+0300"
}
NameRequiredTypeDescription
sitemap_idYesstringID of the sitemap file.
sitemap_urlYesstringURL of the sitemap file.
added_dateYesyyyy-MM-ddTHH:mm:ss,sssZThe date when the file was last visited.

Errors

403 Forbidden

The user ID for the token doesn't match the one specified in the request. In the examples below, {user_id} is the correct uid for the owner of the OAuth token.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
ParameterDescription
error_codeError code.
available_user_idID of the user who allowed access.
error_messageError message.

404 Not Found

  • SITEMAP_NOT_ADDED error

    {
      "error_code": "SITEMAP_NOT_ADDED",
      "host_id": "http:ya.ru:80",
      "sitemap_id": "c7-fe:80-c0",
      "error_message": "explicit error message"
    }
    ParameterDescription
    error_codeThe specified sitemap doesn't exist in the collection of sitemap files added by the user for this site
    host_idSite ID.
    sitemap_idID of the sitemap file.
    error_messageError message.
  • HOST_NOT_VERIFIED error

    {
      "error_code": "HOST_NOT_VERIFIED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    ParameterDescription
    error_codeThe site hasn't been added to the list of sites, or the user hasn't verified site management rights.
    host_idSite ID.
    error_messageError message.