Получить сводный отчет
Описание
Получить сводный отчет.
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 | По мобильному или десктопному трафику | Нет | — |