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

Описание

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

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	*	1	нет	Идентификатор источника данных для отчета
data_group	string	"campaign"	нет	Сгруппировать по ..
show_deleted	bool	false	нет	Показывать ли статистику удаленных объектов
is_test_data	bool	false	нет	Показывать статистику настоящих отправок/тестовых отправок и отправок на базы наблюдателей

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

подсказка

Параметр "data_group" имеет тот же набор значений, что и "data_type".

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

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

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

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

{
    "data": [
        {
            "clicks": 22,
            "complains": 2,
            "confirms": 7,
            "confirmsubs": 0,
            "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,
            "confirmsubs": 0,
            "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"
}

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
id	int	Идентификатор источника данных
clicks_sms	int	Количество кликов в SMS
delivs_sms	int	Количестводоставленных SMS
sends_sms	int	Количествоотправленных SMS
uclicks_sms	int	КоличествоSMS без кликов
undelivs_sms	int	Количество недоставленных SMS
sends	int	Количество отправленных сообщений
delivs	int	Количество доставленных сообщений
hbounces	int	Hard bounces - некорректные адреса email
sbounces	int	Soft bounces - временные проблемы с доставкой
suppresses	int	Количество заблокированных стоп-списком сообщений
undelivs	int	Количество недоставленных сообщений
opens	int	Количество зафиксированных открытий
uopens	int	Количество уникальных открытий
clicks	int	Количество зафиксированных кликов
uclicks	int	Количество уникальных кликов
replies	int	Количество ответов
ulclicks	int	Уникальные клики по ссылке в сообщении
ulconfirmsubs	int	Уникальные клики по ссылке подтверждения
ulunsubs	int	Уникальные клики по ссылке подписки
confirms	int	Количество подтвержденных сообщений
confirmsubs	int	Количество подтвержденных подписок
complains	int	Количество жалоб на спам (FBL)
unsubs	int	Количество отписавшихся
reads	int	Количество прочитанных сообщений
skimmeds	int	количество бегло прочитанных сообщений
glanceds	int	Количество просмотренных сообщений
web_imports	int	Количествовеб импортов
api_imports	int	Количество API импортов
api_unsubs	int	Количество отписок через API
manual_imports	int	Количество импортов вручную
manual_unsubs	int	Количество отписок вручную
file_imports	int	Количество импортов из файла
clicks_push	int	Количество кликов в push
delivs_push	int	Количество доставленных push
offence	int	количество нарушений коммуникационной политики
opens_push	int	Количество зафиксированных открытий push
pixel_opens	int	Количество зафиксированных кликов на пиксель
push_imports	int	Количество push импортов
push_merges	int	Количество объединений push подписок
push_subscribes	int	Количество подписок на push
save_web_version	int	количество сохранённых веб-версий
sends_push	int	Количество отправленных push
submanagers	int	количество открытий менеджера подписок
subscribers	int	Общее количество подписчиков
uclicks_push	int	Уникальные клики в push
ulclicks_push	int	Уникальные клики по ссылке в push
ulclicks_sms	int	Уникальные клики по ссылке в SMS
uopens_push	int	Количество уникальных зафиксированных открытий push