Получение информации о файле Sitemap

Внимание. Вы открыли документацию API версии 3.2. Яндекс Вебмастер перестал поддерживать версию 3.2 и ниже со второго полугодия 2020 г. Рекомендуем использовать API версии 4.1.

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

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

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

GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/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.
Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /user.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts.
sitemap_id Да sitemap id ID файла Sitemap.

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

Примеры

{
  "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"
}
Имя Обязательный Тип Описание
sitemap_id Да string Идентификатор файла Sitemap.
sitemap_url Да string URL файла Sitemap.
last_access_date Да datetime Дата последней загрузки файла.
errors_count Да int32 Количество ошибок в файле.
urls_count Да int64 Количество ссылок в файле.
children_count Да int32 Количество дочерних файлов Sitemap.
source Да ApiSitemapSource Источники, из которых робот узнал об этом файле.
sitemap_type Да ApiSitemapType Тип файла Sitemap.
Имя Обязательный Тип Описание
sitemap_id Да string Идентификатор файла Sitemap.
sitemap_url Да string URL файла Sitemap.
last_access_date Да datetime Дата последней загрузки файла.
errors_count Да int32 Количество ошибок в файле.
urls_count Да int64 Количество ссылок в файле.
children_count Да int32 Количество дочерних файлов Sitemap.
source Да ApiSitemapSource Источники, из которых робот узнал об этом файле.
sitemap_type Да ApiSitemapType Тип файла Sitemap.

Источник файла Sitemap (ApiSitemapSource)

Источник Описание
ROBOTS_TXT Sitemap указан в файле robots.txt сайта.
WEBMASTER Sitemap добавлен пользователем в Яндекс Вебмастере.
INDEX_SITEMAP Sitemap найден в другом (индексном) файле Sitemap.
Источник Описание
ROBOTS_TXT Sitemap указан в файле robots.txt сайта.
WEBMASTER Sitemap добавлен пользователем в Яндекс Вебмастере.
INDEX_SITEMAP Sitemap найден в другом (индексном) файле Sitemap.

Тип файла Sitemap (ApiSitemapType)

Тип Описание
SITEMAP Обычный файл Sitemap, содержащий URL страниц сайта.
INDEX_SITEMAP Индексный файл Sitemap, содержащий URL других файлов Sitemap.
Тип Описание
SITEMAP Обычный файл Sitemap, содержащий URL страниц сайта.
INDEX_SITEMAP Индексный файл Sitemap, содержащий URL других файлов Sitemap.

Коды ответа

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

Код Причина Описание
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"
}
HOST_NOT_LOADED
Данные о сайте еще не загружены в Яндекс Вебмастер.
{
  "error_code": "HOST_NOT_LOADED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
SITEMAP_NOT_FOUND
Файл Sitemap не найден для сайта.
{
  "error_code": "SITEMAP_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "sitemap_id": "c7-fe:80-c0",
  "error_message": "some string"
}
Код Причина Описание
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"
}
HOST_NOT_LOADED
Данные о сайте еще не загружены в Яндекс Вебмастер.
{
  "error_code": "HOST_NOT_LOADED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
SITEMAP_NOT_FOUND
Файл Sitemap не найден для сайта.
{
  "error_code": "SITEMAP_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "sitemap_id": "c7-fe:80-c0",
  "error_message": "some string"
}