Mindbox
Экспорты

Экспорт отчетов по API

Требования

Настроенная операция с шагом «Экспорт — Выгрузить отчет».

Для создания данного шага необходимы права «Экспорт отчетов».
В операции можно выбрать 2 отчета:

  • Сводный отчет по рассылкам;
  • Отчет по рассылкам в динамике — с группировкой данных по дням, неделям или месяцам.

Общий контракт постановки задачи экспорта

Общий контракт постановки задачи экспорта описан здесь

Контракт экспорта отчетов

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

JSONJSON
https://api.mindbox.ru/v3/operations/sync?endpointId={endpointId}&operation={operation}

Accept: application/json
Content-Type: application/json
Authorization: SecretKey {Секретный ключ}

{
  "sinceDate": "<Начальная дата отчета (По времени проекта, YYYY-MM-DD)>",
  "tillDate": "<Конечная дата отчета (По времени проекта, YYYY-MM-DD)>",
  "goalId": "<Идентификатор цели>"
}

Во входных параметрах можно указать временной интервал. Тогда в отчет попадут данные только по тем рассылкам, у которых были отправки за выбранный период.
Также можно указать идентификатор цели в параметре goalId, по которой необходимо экспортировать атрибуцированную к рассылкам выручку. Если не передать id цели в запросе, то экспорт будет осуществлен по цели по умолчанию.

Где взять id цели?

Идентификатор цели (параметр goalId в теле запроса) можно взять в настройках целей и атрибуции, зайдя в настройки нужной цели

Сводный отчет по рассылкам. Описание базовых полей

  • ReportMessageName — Название письма.
  • ReportMessageLink — Ссылка на рассылку.
  • ReportSubject — Тема письма.
  • ReportMessagesTotal — Количество сообщений на отправку.
  • ReportSent — Отправлено сообщений.
  • ReportDeliveryRate — Процент доставок от числа отправленных сообщений.
  • ReportOpenRate — Процент открытий от числа доставленных сообщений.
  • ReportClickRate — Процент кликов от числа доставленных сообщений.
  • ReportCTOR — CTOR = (Количество кликов / Количество открытий) * 100%
  • ReportConversionRate — Конверсия в заказ = (Атрибуцированные заказы / Количество доставленных сообщений) * 100%
  • ReportUnsubscribeRate — Процент отписок от числа доставленных сообщений.
  • ReportSpamRate — Процент жалоб на спам.
  • ReportBounceRate — Процент BounceRate.
  • ReportConversionsRevenue — Выручка из конверсий — выручка от заказов, отнесенных по атрибуции last click к сообщениям, отправленным в заданный период.
  • ReportDelivered — Доставлено.
  • ReportOpened — Открыто (уникальные открытия).
  • ReportClicked — Кликнуто (уникальные клики).
  • ReportConversions — Конверсии — количество заказов, отнесенных по атрибуции last click к сообщениям, отправленным в заданный период.
  • ReportUnsubscribed — Отписки.
  • ReportSpam — Жалоб на спам.
  • ReportBounced — Количество недоставленных сообщений из-за отправки на неактивные и несуществующие адреса.
  • ReportAverageOrderValue — Средний чек — средняя выручка с заказа, отнесенного к рассылке по атрибуции last click. Считается: Выручка из конверсий / Конверсии.
  • ReportConversionRevenuePerRecipient — Доход на получателя
  • ReportStartDate — Дата запуска.
  • ReportTemplate — Шаблон рассылки.
  • ReportChannel — Канал (Email, SMS, MobilePush, WebPush, Viber).
  • ReportFolder — Папка.
  • ReportCategory — Категория (Массовые, Автоматически, Транзакционные).
  • ReportTags — Теги.
  • ReportBrand — Бренд.
  • ReportHeatMap — Тепловая карта (для Email).
  • ReportMailingId — Id рассылки.
  • ReportMailingVariantNum — Номер варианта рассылки (для рассылок без АБ-тестирования — всегда '1').

Отчет по рассылкам в динамике. Описание базовых полей

  • ReportDate — Начальная дата периода (зависит от выбранной группировки в настройках операции. При группировки по дням выводится день, при группировке по неделям и месяцам выводится первый день недели или месяца)
  • ReportMessageName — Название письма.
  • ReportMessageLink — Ссылка на рассылку.
  • ReportSubject — Тема письма.
  • ReportRevenue — Выручка от заказов, отнесенных к рассылке по атрибуции last click и совершенных в заданном периоде. Не учитываются заказы и позиции заказов, которые были отменены.
  • ReportOrders — Количество заказов, отнесенных к рассылке по атрибуции last click. Конверсия не будет засчитана, если заказ был отменен.
  • ReportMessagesTotal — Количество сообщений на отправку.
  • ReportSent — Отправлено сообщений.
  • ReportDeliveryRate — Процент доставок от числа отправленных сообщений.
  • ReportOpenRate — Процент открытий от числа доставленных сообщений.
  • ReportClickRate — Процент кликов от числа доставленных сообщений.
  • ReportCTOR — CTOR = (Количество кликов / Количество открытий) * 100%
  • ReportConversionRate — Конверсия в заказ = (Атрибуцированные заказы / Количество доставленных сообщений) * 100%
  • ReportUnsubscribeRate — Процент отписок от числа доставленных сообщений.
  • ReportSpamRate — Процент жалоб на спам.
  • ReportBounceRate — Процент BounceRate.
  • ReportConversionsRevenue— Выручка из конверсий — выручка от заказов, отнесенных по атрибуции last click к сообщениям, отправленным в заданный период.
  • ReportDelivered — Доставлено.
  • ReportOpened — Открыто (уникальные открытия).
  • ReportClicked — Кликнуто (уникальные клики).
  • ReportConversions — Конверсии — количество заказов, отнесенных по атрибуции last click к сообщениям, отправленным в заданный период.
  • ReportUnsubscribed — Отписки.
  • ReportSpam — Жалоб на спам.
  • ReportBounced — Количество недоставленных сообщений из-за отправки на неактивные и несуществующие адреса.
  • ReportAverageOrderValue — Средний чек — средняя выручка с заказа, отнесенного к рассылке по атрибуции last click. Считается: Выручка из конверсий / Конверсии.
  • ReportConversionRevenuePerRecipient — Доход на получателя = Выручка из конверсий / Количество доставленных сообщений.
  • ReportStartDate — Дата запуска.
  • ReportTemplate — Шаблон рассылки.
  • ReportChannel — Канал (Email, SMS, MobilePush, WebPush, Viber).
  • ReportFolder — Папка.
  • ReportCategory — Категория (Массовые, Автоматически, Транзакционные).
  • ReportTags — Теги.
  • ReportBrand — Бренд.
  • ReportHeatMap — Тепловая карта (для Email).
  • ReportMailingId — Id рассылки.
  • ReportMailingVariantNum — Номер варианта рассылки (для рассылок без АБ-тестирования — всегда '1').

Обратная совместимость

Обратная совместимость значений полей экспорта не поддерживается.

Last modified on
Экспорт статусов рассылокЭкспорт сценариев