Получение проблем уровня сайта

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

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/feeds/host-problems
  ? [type=<string>]
  & [severity=<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 — объявления об образовательных курсах или уроках, которые проводятся онлайн (например, курсы программирования).

severity

Фильтр по серьезности: ERROR — ошибка, WARNING — замечание.

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

Примеры

{
  "errorsCount": 2,
  "warningsCount": 0,
  "problems": [
    {
      "type": "SERVICES",
      "code": "TOO_FEW_OFFERS_FOR_SET",
      "severity": "ERROR",
      "count": 2,
      "samples": [
        {
          "setUrl": "https://example.com/set/101",
          "screenshotUrl": "https://example.com/screenshots/101.png",
          "message": "Недостаточно предложений в наборе"
        }
      ]
    }
  ]
}
<Data>
    <errorsCount>2</errorsCount>
    <warningsCount>0</warningsCount>
    <problem>
        <type>SERVICES</type>
        <code>TOO_FEW_OFFERS_FOR_SET</code>
        <severity>ERROR</severity>
        <count>2</count>
        <sample>
            <message>Недостаточно предложений в наборе</message>
            <setUrl>https://example.com/set/101</setUrl>
            <screenshotUrl>https://example.com/screenshots/101.png</screenshotUrl>
        </sample>
    </problem>
</Data>

Имя

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

Тип

Описание

errorsCount

Да

int64

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

warningsCount

Да

int64

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

problems

Да

array

Группы проблем.

problems[].type

Да

string

Тип фида, к которому относится проблема.

problems[].code

Да

string

Код проблемы.

problems[].severity

Да

string

Серьезность: ERROR — ошибка, WARNING — замечание.

problems[].count

Да

int64

Число вхождений проблемы.

problems[].samples

Да

array

Примеры.

problems[].samples[].message

Да

string

Текст ошибки или замечания.

problems[].samples[].setUrl

Нет

url

URL набора предложений.

problems[].samples[].screenshotUrl

Нет

url

URL скриншота с примером проблемы.

Коды ответа

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

Код

Причина

Описание

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 — объявления об образовательных курсах или уроках, которые проводятся онлайн (например, курсы программирования).

Фильтр по серьезности: ERROR — ошибка, WARNING — замечание.

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

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

Группы проблем.

Тип фида, к которому относится проблема.

Код проблемы.

Серьезность: ERROR — ошибка, WARNING — замечание.

Число вхождений проблемы.

Примеры.

Текст ошибки или замечания.

URL набора предложений.

URL скриншота с примером проблемы.