Получение сводки по фидам

Возвращает сводку по YML-фидам сайта: распределение по статусам и счетчики ошибок.

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/feeds/summary
  ? [type=<string>]

user-id

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

host-id

Тип: string. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

type

Категория бизнеса, для которого загружен фид. Возможные значения:

  • REALTY — продажа или аренда квартир, офисов, домов и других построек;

  • VACANCY — предложения работы;

  • DOCTORS — информация об услугах врачей (например, прием педиатра);

  • CARS — продажа автомобилей, мотоциклов и других средств передвижения;

  • SERVICES — объявления исполнителей бытовых и других услуг (например, перевозка мебели);

  • EDUCATION — объявления об образовательных курсах или уроках, которые проводятся онлайн (например, курсы программирования).

Без фильтра — сводка по всем фидам.

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

Примеры

{
  "count": 100,
  "byStatus": {
    "IN_PROGRESS": 5,
    "SUCCESS": 90,
    "ERROR": 5
  },
  "feedErrorsCount": 12,
  "feedWarningsCount": 3,
  "hostErrorsCount": 1,
  "hostWarningsCount": 0,
  "moderationRejectedOffersCount": 2
}

<Data>
    <count>100</count>
    <byStatus>
        <IN_PROGRESS>5</IN_PROGRESS>
        <SUCCESS>90</SUCCESS>
        <ERROR>5</ERROR>
    </byStatus>
    <feedErrorsCount>12</feedErrorsCount>
    <feedWarningsCount>3</feedWarningsCount>
    <hostErrorsCount>1</hostErrorsCount>
    <hostWarningsCount>0</hostWarningsCount>
    <moderationRejectedOffersCount>2</moderationRejectedOffersCount>
</Data>

Имя

Обязательный

Тип

Описание

count

Да

int32

Число фидов под фильтром.

byStatus

Да

object

Разбивка фидов по статусам. Ключи объекта — значения статуса фида, значения — число фидов в каждом статусе.

feedErrorsCount

Да

int64

Суммарное количество ошибок по фидам.

feedWarningsCount

Да

int64

Суммарное количество замечаний по фидам.

hostErrorsCount

Да

int64

Суммарное количество ошибок на уровне сайта.

hostWarningsCount

Да

int64

Суммарное количество замечаний на уровне сайта.

moderationRejectedOffersCount

Да

int64

Суммарное количество предложений, отклоненных модерацией.

Коды ответа

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

Код

Причина

Описание

200

OK

403

INVALID_USER_ID

 
{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}

<Data>
    <error_code>INVALID_USER_ID</error_code>
    <available_user_id>1</available_user_id>
    <error_message>Invalid user id. {user_id} should be used.</error_message>
</Data>

404

HOST_NOT_VERIFIED

 
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}

<Data>
  <error_code>HOST_NOT_VERIFIED</error_code>  
  <host_id>http:ya.ru:80</host_id>
  <error_message>some string</error_message>
</Data>

Узнайте больше

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

Тип: string. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

Категория бизнеса, для которого загружен фид. Возможные значения:

  • REALTY — продажа или аренда квартир, офисов, домов и других построек;

  • VACANCY — предложения работы;

  • DOCTORS — информация об услугах врачей (например, прием педиатра);

  • CARS — продажа автомобилей, мотоциклов и других средств передвижения;

  • SERVICES — объявления исполнителей бытовых и других услуг (например, перевозка мебели);

  • EDUCATION — объявления об образовательных курсах или уроках, которые проводятся онлайн (например, курсы программирования).

Число фидов под фильтром.

Разбивка фидов по статусам. Ключи объекта — значения статуса фида, значения — число фидов в каждом статусе.

Суммарное количество ошибок по фидам.

Суммарное количество замечаний по фидам.

Суммарное количество ошибок на уровне сайта.

Суммарное количество замечаний на уровне сайта.

Суммарное количество предложений, отклоненных модерацией.

Предыдущая
Получение информации об одном фиде
Следующая
Получение проблем фида