Получение информации о Sitemap, добавленном пользователем

Возвращает подробную информацию о файле Sitemap, добавленном пользователем, включая тип файла, дату и способ загрузки файла в Яндекс.Вебмастер, дату обработки файла сервисом, количество содержащихся в файле URL, а также количество и тип обнаруженных ошибок.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

Формат запроса

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

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user/.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts/.
sitemap-id Да sitemap id ID файла Sitemap.

Формат ответа

В случае успеха сервер возвращает 200 OK и информацию о запрошенном файле Sitemap.

Примеры

{
  "sitemap_id": "c7-fe:80-c0",
  "sitemap_url": "explicit error message",
  "added_date": "2016-01-01T00:00:00,000+0300"
}
Имя Обязательный Тип Описание
sitemap_id Да string ID файла sitemap.
sitemap_url Да string URL файла sitemap.
added_date Да datetime Дата последней загрузки файла.

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код Причина Описание
200 OK
403

INVALID_USER_ID

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
SITEMAP_NOT_ADDED
Файл Sitemap отсутствует.
{
  "error_code": "SITEMAP_NOT_ADDED",
  "host_id": "http:ya.ru:80",
  "sitemap_id": "c7-fe:80-c0",
  "error_message": "some string"
}