Сводная статистика рассылок

Получить сводную статистику по рассылкам с указанного почтового домена или адреса. Для каждой рассылки приводится общее число сообщений с различным статусом: прочитано, не прочитано, отмечено как спам, удалено.

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

https://postoffice.yandex.ru/api/1.0/stat-list
 ? oauth_token=<токен>
 & (domain=<домен> | email=<адрес>)
 & [group=<тип группировки>]
 & [offset=<смещение>]
Query-параметры
oauth_token *

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

domain *

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

email *

Адрес электронной почты, по рассылкам с которого нужно вывести статистику.

group

Тип группировки статистических данных в ответе. Допустимые значения:

  • subject — по теме сообщения;
  • from — по отправителю;
  • date — по дате отправки сообщения;
  • listid — по значению заголовка List-ID.

Если параметр group не указан в запросе, выполняется группировка по дате, теме и отправителю.

offset

Вывести результаты, начиная с указанного номера. Значение — целое число.

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

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

Возвращает статистические данные о рассылках с указанного домена или адреса. Данные возвращаются в агрегированном виде. Принцип группировки задается параметром group.

{
    "session":"peiN4cho",
    "offset":"eof",
    "list": [
        {   
            "subject":"No subject",
            "id":"4568638327583785227",
            "from":"someuser@example.com",
            "year":"2013",
            "month":"11",
            "day":"5",
            "messages":557,
            "read":91,
            "not_read":363,
            "spam":0,
            "deleted":103
        }   
    ]   
}
session

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

offset

Смещение для запроса следующей страницы результатов. Допустимые значения:

  • Целое число — значение смещения для запроса следующей страницы выдачи.
  • eof — последняя страница выдачи (больше результатов нет).
list

Список групп, содержащих агрегированные статистические сведения о рассылках. Список выводится постранично, в результате каждого запроса возвращается не более 20 групп.

Значение — массив. Элемент массива — хэш, описывающий группу. В хэш включаются поля, имеющие смысл при заданном типе группировки данных. Ниже приведен полный список возможных полей. При любом типе группировки в описании присутствуют поля messages, read, not_read, spam, deleted.

subject

Тема сообщений, составляющих группу. Выводится только при группировке по теме сообщения.

id

Числовой идентификатор сообщений, составляющих группу. Представляет собой хэш-сумму, вычисленную на основании домена отправителя и темы сообщения. Выводится только при группировке по теме сообщения.

Значение поля id используется для запроса статистики по теме сообщения с помощью метода stat-view.

from

Отправитель сообщений, составляющих группу, — значение заголовка From. Выводится только при группировке по отправителю.

year

Год отправки сообщений, составляющих группу. Выводится только при группировке по дате.

month

Месяц отправки сообщений, составляющих группу. Допустимые значения: 1-12. Выводится только при группировке по дате.

day

День отправки сообщений, составляющих группу. Допустимые значения: 1-31. Выводится только при группировке по дате.

messages

Общее количество сообщений, вошедших в группу.

Значение должно равняться сумме значений в полях read, not_read, spam и deleted.

read

Количество сообщений, прочитанных получателями.

В это значение не включаются сообщения:

  • удаленные получателем;
  • помеченные получателем как спам;
  • доставленные в папку Спам автоматически средствами Спамообороны.
not_read

Количество сообщений, доставленных во Входящие, но не прочитанных получателями.

В это значение не включаются удаленные и помеченные как спам сообщения.

spam

Количество сообщений, помеченных как спам пользователем или автоматически средствами Спамообороны. В это значение включаются как прочитанные, так и не прочитанные получателем сообщения.

В это значение не включаются сообщения, удаленные пользователем (даже если они предварительно были отмечены как спам).

deleted

Количество сообщений, удаленных получателем. В это значение включаются как прочитанные, так и не прочитанные получателем сообщения.

В это значение не включаются сообщения, помеченные как спам.