Список жалоб на спам

Получить количество и список email-адресов пользователей, которые отметили письма из рассылки как спам. Список формируется по указанному почтовому домену или адресу, идентификатору или дате рассылки.

Синтаксис запроса

https://postoffice.yandex.ru/api/1.0/stat-bad
 ? oauth_token=<токен>
 & (domain=<домен> | email=<адрес>)
 & [id=<идентификатор рассылки>]
 & [listid=<List-ID>]
 & [year=<год>]
 & [month=<месяц>]
 & [day=<день>]
 & [get=<количество получателей>]
Query-параметры
oauth_token *

Токен доступа OAuth. Подробнее о процедуре получения токена см. в разделе Авторизация приложения с помощью OAuth-токена.

domain *

Почтовый домен — источник рассылок.

email *

Адрес электронной почты — источник рассылок.

id

Числовой идентификатор рассылки. В качестве идентификатора используется значение поля id в ответе метода stat-list.

Если параметр id указан, в выборке участвует только рассылка с указанным идентификатором.

listid

Идентификатор рассылки — значение заголовка List-ID.

year

Год рассылки. Значение — четырехзначное число.

Если параметр year указан, в выборке участвует только рассылки указанного года.

month

Месяц рассылки. Допустимые значения: 1-12.

Если параметр month указан, в выборке участвует только рассылки указанного месяца.

day

День рассылки. Допустимые значения: 1-31.

Если параметр day указан, в выборке участвует только рассылки указанного дня.

get

Количество получателей. Допустимое значение: count.

Если параметр get указан, выводится количество email-адресов пользователей, которые отметили письма из рассылки как спам.

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

Внимание. В одном запросе можно формировать группировку только по идентификатору рассылки (параметры: id и listid) или только по дате (параметры: year, month и day).

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

Может возвращать два варианта ответа:

  • Если параметр get не указан в запросе, возвращает список email-адресов пользователей, которые отметили письма из рассылки как спам.

    {
      "session": "WbB5JTsn", 
      "rcpts": 
      [
        "possstmaster@yandex.ru", 
        "possstmaster@ya.ru"
      ]
    }
  • Если параметр get указан в запросе, возвращает количество email-адресов пользователей, которые отметили письма из рассылки как спам.

    {
      "session": "WbB5JTsn", 
      "count": 2 
    }
session

Идентификатор сессии, в рамках которой обрабатывался запрос к API. Сообщайте этот идентификатор при обращении в службу поддержки Яндекса по поводу сбоев или ошибок в работе API Почтового офиса.

rcpts

Список email-адресов пользователей, которые отметили письма из рассылки как спам.

count

Количество email-адресов пользователей, которые отметили письма из рассылки как спам.