Получение проблем фида

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

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

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

user-id

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

host-id

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

url*

URL фида.

severity

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

* Обязательный параметр

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

Примеры

{
  "url": "https://example.com/feeds/feed.yml",
  "errorsCount": 2,
  "warningsCount": 1,
  "problems": [
    {
      "code": "REQUIRED_FIELD",
      "severity": "ERROR",
      "count": 2,
      "samples": [
        {
          "offerUrl": "https://example.com/item/1",
          "message": "Не заполнено обязательное поле price",
          "line": 42,
          "column": 12,
          "context": "<offer id=\"1\">…</offer>"
        }
      ]
    },
    {
      "code": "INVALID_NUMBER",
      "severity": "WARNING",
      "count": 1,
      "samples": [
        {
          "offerUrl": "https://example.com/item/2",
          "message": "Некорректное значение в теге price"
        }
      ]
    }
  ]
}
<Data>
    <url>https://example.com/feeds/feed.yml</url>
    <errorsCount>2</errorsCount>
    <warningsCount>1</warningsCount>
    <problem>
        <code>REQUIRED_FIELD</code>
        <severity>ERROR</severity>
        <count>2</count>
        <sample>
            <message>Не заполнено обязательное поле price</message>
            <offerUrl>https://example.com/item/1</offerUrl>
            <line>42</line>
            <column>12</column>
            <context>&lt;offer id="1">…&lt;/offer></context>
        </sample>
    </problem>
</Data>

Имя

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

Тип

Описание

url

Да

url

URL фида.

errorsCount

Да

int64

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

warningsCount

Да

int64

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

problems

Да

array

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

problems[].code

Да

string

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

problems[].severity

Да

string

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

problems[].count

Да

int64

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

problems[].samples

Да

array

Примеры проблемных предложений.

problems[].samples[].message

Да

string

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

problems[].samples[].offerId

Нет

string

ID предложения.

problems[].samples[].offerUrl

Нет

url

URL предложения.

problems[].samples[].pictureUrl

Нет

url

URL изображения.

problems[].samples[].line

Нет

int32

Строка в файле фида.

problems[].samples[].column

Нет

int32

Столбец в файле фида.

problems[].samples[].context

Нет

string

Фрагмент XML с проблемным местом.

Коды ответа

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

Код

Причина

Описание

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

INCORRECT_URL

{
  "error_code": "INCORRECT_URL",
  "error_message": "some string"
}
<Data>
  <error_code>INCORRECT_URL</error_code>  
  <error_message>some string</error_message>
</Data>

404

FEED_NOT_FOUND

Фид с указанным URL не найден у сайта.

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.

URL фида.

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

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

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

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

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

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

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

Примеры проблемных предложений.

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

URL предложения.

Строка в файле фида.

Столбец в файле фида.

Фрагмент XML с проблемным местом.

* Обязательный параметр