Получить сводный отчет

Описание

Получить сводный отчет.

URL-адрес

Метод: POST

https://example.com/api/v1.1/reports/summary

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
resource_id	int	1	Нет	Идентификатор ресурса
date_from	string	"2018-08-10"	Да	Начало временного диапазона
date_to	string	"2018-08-15"	Да	Конец временного диапазона
data_type	string	"segment"	Да	Источник подписчиков для отчета
data_id	int/string	1	Нет	Идентификатор источника данных для отчета
data_group	string	"day"	Нет	Параметр группировки ("day" , "week" или "month")
show_deleted	bool	false	Нет	Показывать ли статистику удаленных объектов
is_test_data	bool	false	Нет	Показывать статистику настоящих отправок/тестовых отправок и отправок на базы наблюдателей

Список объектов для отчета:

data_type	Описание	Можно передать параметр "data_id"	Тип параметра "data_id"
campaign	По рассылкам	Да	int
list	По базам	Да	int
segment	По сегментам	Да	int
message	По сообщениям	Да	int
sender	По сендерам	Да	int
domaingroup	По группе доменов	Да	string
domain	По доменам	Нет	—
vendor	По идентификатору формы импорта	Нет	—
day	Ежедневный отчет	Нет	—
week	Еженедельный отчет	Нет	—
month	Ежемесячный отчет	Нет	—
environment	По мобильному или десктопному трафику	Нет	—

Пример запроса

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "data_group": "vendor",
    "data_id": 7,
    "data_type": "list",
    "date_from": "2024-04-04",
    "date_to": "2024-05-05",
    "format": "json"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <data_group>vendor</data_group>
  <data_id>7</data_id>
  <data_type>list</data_type>
  <date_from>2024-04-04</date_from>
  <date_to>2024-05-05</date_to>
  <format>xml</format>
</xml>

Пример ответа

JSON

{
    "data": [
        {
            "clicks": 22,
            "complains": 2,
            "confirms": 7,
            "delivs": 22,
            "hbounces": 3,
            "id": "Vendor #2",
            "opens": 44,
            "reads": 2,
            "sbounces": 15,
            "sends": 41,
            "suppresses": 1,
            "uclicks": 15,
            "unsubs": 3,
            "uopens": 22
        },
        {
            "clicks": 34,
            "complains": 4,
            "confirms": 13,
            "delivs": 24,
            "hbounces": 7,
            "id": "Vendor #1",
            "opens": 48,
            "reads": 3,
            "sbounces": 21,
            "sends": 31,
            "suppresses": 3,
            "uclicks": 21,
            "unsubs": 6,
            "uopens": 24
        }
    ],
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <clicks>22</clicks>
    <complains>2</complains>
    <confirms>7</confirms>
    <confirmsubs>0</confirmsubs>
    <delivs>22</delivs>
    <hbounces>3</hbounces>
    <id>Vendor #2</id>
    <opens>44</opens>
    <reads>2</reads>
    <sbounces>15</sbounces>
    <sends>41</sends>
    <suppresses>1</suppresses>
    <uclicks>15</uclicks>
    <unsubs>3</unsubs>
    <uopens>22</uopens>
  </data>
  <data>
    <clicks>34</clicks>
    <complains>4</complains>
    <confirms>13</confirms>
    <confirmsubs>0</confirmsubs>
    <delivs>24</delivs>
    <hbounces>7</hbounces>
    <id>Vendor #1</id>
    <opens>48</opens>
    <reads>3</reads>
    <sbounces>21</sbounces>
    <sends>31</sends>
    <suppresses>3</suppresses>
    <uclicks>21</uclicks>
    <unsubs>6</unsubs>
    <uopens>24</uopens>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
id	string	Идентификатор источника данных
clicks	int	Количество зафиксированных кликов
complains	int	Количество жалоб на спам (FBL)
opens	int	Количество зафиксированных открытий
reads	int	Количество прочитанных сообщений
replies	int	Количество ответов
sends	int	Количество отправленных сообщений
confirms	int	Количество подтвержденных сообщений
delivs	int	Количество доставленных сообщений
undelivs	int	Количество недоставленных сообщений
unsubs	int	Количество отписавшихся
uopens	int	Количество уникальных открытий
ureads	int	Уникальных прочтений
offence	int	Количество нарушений коммуникационной политики
glanceds	int	Количество просмотренных сообщений
hbounces	int	Hard bounces — некорректные адреса email
sbounces	int	Soft bounces — временные проблемы с доставкой
suppresses	int	Количество заблокированных стоп-списком сообщений
uclicks	int	Количество уникальных кликов
ulclicks	int	Количество уникальных кликов по ссылкам отписки
sends_push	int	Количество отправленных push
clicks_push	int	Количество кликов в push
uclicks_push	int	Уникальные клики в push
delivs_push	int	Количество доставленных push
ureads_push	int	Уникальные прочтения push
opens_push	int	Количество зафиксированных открытий push
uopens_push	int	Количество уникальных открытий push
push_ctr	int	Отношение кликов по ссылке ко всем отправленым push
sbounce_push	int	Soft bounce в push
hbounce_push	int	Hard bounce в push
sends_sms	int	Количество отправленных SMS
clicks_sms	int	Количество кликов в SMS
uclicks_sms	int	Уникальные клики в SMS
delivs_sms	int	Количество доставленных SMS
undelivs_sms	int	Количество недоставленных SMS
sms_ctr	int	Отношение кликов по ссылке ко всем отправленым SMS
unsubs_sms	int	Отписок в SMS
open_rate	int	Процент открытий
push_deliv_rate	int	Процент доставок push
u_read_rate	int	Процент уникальных прочтений
u_open_click_rate	int	Соотношение уникальных открытий к уникальным кликам
sb_rate	int	Процент Soft bounce
email_read_rate	int	Процент прочтений email
delivery_rate	int	Процент доставок
email_unsub_rate	int	Процент отписок в email
email_u_read_rate	int	Процент уникальных прочтений email
open_click_rate	int	Соотношение открытий писем к кликам
suppresses_rate	int	Процент заблокированных стоп-списком сообщений
unsub_rate	int	Процент отписок
u_click_rate	int	Процент уникальных кликов
click_rate	int	Процент кликов
sms_deliv_rate	int	Процент доставок SMS
hb_rate	int	Процент Hard bounce
push_open_rate	int	Процент открытий push
undelivs_push	int	Недоставки push
complain_rate	int	Процент жалоб
u_open_rate	int	Процент уникальных открытий
email_reply_rate	int	Процентов ответов в email
sends_total	int	Всего отправлено
delivs_total	int	Всего доставлено
undelivs_total	int	Всего недоставок
reads_total	int	Всего прочтений
clicks_total	int	Всего кликов
uclicks_total	int	Всего уникальных кликов
opens_total	int	Всего открытий
ureads_total	int	Всего уникальных прочтений
uopens_total	int	Всего уникальных открытий