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

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

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

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

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

Path-параметры

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

Query-параметры

ИмяОбязательныйТипЗначение по умолчаниюОписание
parent_idНетsitemap idID родительского Sitemap.
limitНетint3210Размер страницы (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ДаstringID файла Sitemap.
sitemap_urlДаstringURL файла 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_TXTSitemap указан в файле robots.txt сайта.
WEBMASTERSitemap добавлен пользователем в Яндекс.Вебмастере.
INDEX_SITEMAPSitemap найден в другом (индексном) файле Sitemap.

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

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

Коды ответа

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

КодПричинаОписание
200OK
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."
}
404HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}