Получение списка файлов Sitemap

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

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

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

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

GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/sitemaps/[?parent_id={parent_id}&limit={limit}&from={from}]

Path-параметры

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

Query-параметры

Имя Обязательный Тип Значение по умолчанию Описание
parent_id Нет sitemap id ID родительского Sitemap.
limit Нет int32 10 Размер страницы (1-100).
from Нет sitemap id Получить файлы Sitemap, отсчитывая от указанного (исключительно).
Имя Обязательный Тип Значение по умолчанию Описание
parent_id Нет sitemap id ID родительского Sitemap.
limit Нет int32 10 Размер страницы (1-100).
from Нет sitemap id Получить файлы Sitemap, отсчитывая от указанного (исключительно).

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

В случае успеха сервер возвращает 200 OK и список файлов Sitemap сайта.

Примеры

{
  "sitemaps": [
    {
      "sitemap_id": "c7-fe:80-c0",
      "sitemap_url": "explicit error message",
      "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 ID файла Sitemap.
sitemap_url Да string URL файла Sitemap.
last_access_date Нет yyyy-MM-ddTHH:mm:ss,sssZ Дата последней загрузки файла.
errors_count Да int32 Количество ошибок в файле.
urls_count Да int64 Количество ссылок в файле.
children_count Да int32 Количество дочерних файлов Sitemap.
source Да ApiSitemapSource Источники, из которых робот узнал об этом файле.
sitemap_type Да ApiExplicitVerificationType Тип файла Sitemap.
Имя Обязательный Тип Описание
sitemap_id Да string ID файла Sitemap.
sitemap_url Да string URL файла Sitemap.
last_access_date Нет yyyy-MM-ddTHH:mm:ss,sssZ Дата последней загрузки файла.
errors_count Да int32 Количество ошибок в файле.
urls_count Да int64 Количество ссылок в файле.
children_count Да int32 Количество дочерних файлов Sitemap.
source Да ApiSitemapSource Источники, из которых робот узнал об этом файле.
sitemap_type Да ApiExplicitVerificationType Тип файла 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"
}
Код Причина Описание
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"
}