Статистика сообщений

messages:list

Отображает список отправленных сообщений.

POST https://api.wavesend.ru/api/v2/messages:list

Заголовки

Название	Обязательно	Тип	Описание
Authorization	Да	String	Токен доступа к API из Wavesend Control Panel.

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

Название	Обязательно	Тип	Описание
platforms	Нет	Array	Платформы для сообщений. Возможные значения: "IOS", "ANDROID", "OSX", "WINDOWS", "AMAZON", "SAFARI", "CHROME", "FIREFOX", "IE", "EMAIL", "HUAWEI_ANDROID", "SMS".
date_range	Нет	Object	Отчетный период. date_from и date_to должны соответствовать формату ГГГГ-ММ-ДД (например, "2000-01-01").
campaign	Нет	String	Код Campaign.
filters	Да	Object	Фильтры сообщений.
source	Нет	String	Источник сообщения. Например: AB_TEST, API, AUTO_PUSH, CP, CSV, CUSTOMER_JOURNEY, EMAIL_API, EMAIL_CP, GEO_ZONE, PUSH_ON_EVENT, RSS.
messages_codes	Нет	Array	Коды сообщений, полученные из ответов API /createMessage.
messages_ids	Нет	Array	ID сообщений, полученные из Message History.
params	Нет	Object	Укажите, нужно ли показывать детали и метрики сообщения. Установите with_details: true, чтобы включить объект details, и with_metrics: true, чтобы включить объект metrics в ответ.
application	Да	String	Код Application Wavesend.
per_page	Нет	Integer	Количество результатов на странице (≤ 1000).
page	Нет	Integer	Номер страницы для пагинации.

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

{
    "filters": {
      "platforms": [],                  // IOS, ANDROID, OSX, WINDOWS, AMAZON, SAFARI, CHROME, FIREFOX, IE, EMAIL, HUAWEI_ANDROID, SMS
      "date_range": {
        "date_from": "string",          // Обязательный формат: 2000-01-01
        "date_to": "string"             // Обязательный формат: 2000-01-01
      },
      "source": "API",                  // AB_TEST, API, AUTO_PUSH, CP, CSV, CUSTOMER_JOURNEY, EMAIL_API, EMAIL_CP, GEO_ZONE, PUSH_ON_EVENT, RSS
      "campaign": "string",             // Код Campaign
      "messages_ids": [],               // ID сообщений
      "messages_codes": [],             // Коды сообщений
      "application": "string"           // Код Application Wavesend
    },
    "params": {
      "with_details": true,             // Добавить детали сообщения в ответ (объект "details")
      "with_metrics": true              // Добавить метрики сообщения в ответ (объект "metrics")
    },
    "per_page": 20,                     // <= 1000
    "page": 0
}

Коды ответа и примеры

200: OK

{
  "total": 0,
  "items": [{
    "id": 0,
    "code": "string",
    "created_date": "string",
    "send_date": "string",
    "status": "string",
    "platforms": [],
    "source": "string",
    "push_info": {
      "details": {
        "title": "string",
        "filter_name": "string",
        "filter_code": "string",
        "content": {
          "key": "value"
        },
        "platform_parameters": {
          "android_header": "string",
          "android_root_params": {
            "key": "value"
          },
          "ios_title": "string",
          "ios_subtitle": "string",
          "ios_root_params": {
            "key": "value"
          },
          "chrome_header": "string",
          "chrome_root_params": {
            "key": "value"
          },
          "firefox_header": "string",
          "firefox_root_params": {
            "key": "value"
          },
          "conditions": [               // условия тегов (см. /developer/api-reference/messages-api/#tag-conditions)
            TAG_CONDITION1,
            TAG_CONDITION2,
            ...,
            TAG_CONDITIONN
          ],
          "conditions_operator": "AND", // логический оператор для массивов условий; возможные значения: AND, OR
          "data": {
            "key": "value"
          }
        },
        "follow_user_timezone": true
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "inbox_opens": 0,
        "unshowable_sends": 0,
        "errors": 0,
        "platform": 0
      }]
    },
    "email_info": {
      "details": {
        "template": "string",
        "filter_name": "string",
        "filter_code": "string",
        "subject": {
          "key": "value"
        },
        "from_name": "string",
        "from_email": "string",
        "reply_name": "string",
        "reply_email": "string",
        "follow_user_timezone": true,
        "conditions": [              // условия тегов (см. developer/api-reference/messages-api/#tag-conditions)
          TAG_CONDITION1,
          TAG_CONDITION2,
          ...,
          TAG_CONDITIONN
        ],
        "conditions_operator": "AND" // логический оператор для массивов условий; возможные значения: AND, OR
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "hard_bounces": 0,
        "soft_bounces": 0,
        "rejects": 0,
        "confirmed_sends": 0,
        "unsubs": 0,
        "complaints": 0,
        "errors": 0
      }]
    }
  }]
}

400: Ошибка некорректного запроса

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

401: Неверный токен доступа к API

{
  "error": "account not found"
}

500: Внутренняя ошибка сервера

Note

Для iOS убедитесь, что вы добавили Notification Service Extension в ваш проект для отслеживания доставки Push. Узнать больше

totalsByIntervals

Возвращает метрики и данные о Conversion на основе кода сообщения, сгруппированные по часам.

POST https://api.wavesend.ru/api/v2/statistics/messages/totalsByIntervals

Авторизация

Авторизация осуществляется через API Access Token в заголовке запроса.

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

Имя параметра	Тип	Описание	Обязательно
message_code	string	Код сообщения, полученный из ответов API /createMessage.	Да
platforms	[int]	Платформы	Нет

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

{
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // обязательно. Уникальный идентификатор сообщения
  "platforms": [1, 3, 7, 10, 11, 12]          // необязательно. Список кодов платформ
}

Поля ответа

Название	Тип	Описание
metrics	array	Содержит массив метрик сообщения
timestamp	string	Время метрики.
platform	int	Код платформы (например, iOS, Android).
sends	string	Количество отправленных сообщений.
opens	string	Количество открытых сообщений.
deliveries	string	Количество доставленных сообщений.
inbox_opens	string	Количество открытий из папки «Входящие».
unshowable_sends	string	Количество отправленных сообщений, которые не удалось показать.
errors	string	Количество ошибок.
conversion	object	Содержит данные о Conversion
sends	string	Общее количество отправленных сообщений.
opens	string	Общее количество открытых сообщений.
events	array	Массив событий с их статистикой
name	string	Название события (например, добавление в корзину).
hits	string	Количество обращений.
conversion	float	Коэффициент Conversion относительно открытий.
revenue	float	Доход (только для событий с атрибутами __amount и __currency).

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

{
  "metrics": [{
    "timestamp": "2024-08-03 15:00:00",  // Временная метка метрик в формате "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
    "platform": 3,                       // Код платформы
    "sends": "55902",                    // Количество отправленных сообщений
    "opens": "382",                      // Количество открытых сообщений
    "deliveries": "22931",               // Количество доставленных сообщений
    "inbox_opens": "0",                  // Количество сообщений, открытых из папки «Входящие»
    "unshowable_sends": "2",             // Количество сообщений, которые не удалось показать
    "errors": "0"                        // Количество возникших ошибок
  }],
  "conversion": {
    "sends": "55902",                    // Общее количество отправленных сообщений
    "opens": "772",                      // Общее количество открытых сообщений
    "events": [{
      "name": "cart_add",                // Название события
      "hits": "96",                      // Количество обращений к событию
      "conversion": 0.12,                // Коэффициент Conversion относительно открытий
      "revenue": 0                       // Доход, полученный от события (только для событий с атрибутами amount/currency)
    }]
  }
}

getMessageLog

Отображает подробную информацию об отправленных сообщениях.

POST https://api.wavesend.ru/api/v2/statistics/getMessageLog

Заголовки

Название	Обязательно	Тип	Описание
Authorization	Обязательно	String	Токен доступа к API из Wavesend Control Panel.

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

Название	Обязательно/Необязательно	Тип	Описание
message_id	Необязательно	Integer	Выбор событий сообщений по ID сообщения, полученному из Message History. Пример: 12345678900.
message_code	Необязательно	String	Выбор событий сообщений по коду сообщения, полученному из ответов API /createMessage. Пример: "A444-AAABBBCC-00112233".
campaign_code	Необязательно	String	Выбор событий сообщений по коду Campaign, указанному в полезной нагрузке сообщения. Пример: "AAAAA-XXXXX".
hwid	Необязательно	String or Array	Выбор событий сообщений по HWID (Hardware ID) или массиву HWID.
date_from	Обязательно, если не указаны message_id, message_code или campaign_code	Datetime	Дата начала для фильтрации сообщений. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС". Пример: "2000-01-25 00:00:00".
date_to	Обязательно, если не указаны message_id, message_code или campaign_code	Datetime	Дата окончания для фильтрации сообщений. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС". Пример: "2000-01-26 00:00:00".
limit	Необязательно	Integer	Максимальное количество событий сообщений, возвращаемых в одном ответе. Максимальное значение: 100000.
pagination_token	Необязательно	String	Токен пагинации, полученный из предыдущего ответа /getMessageLog. Используйте его для получения дополнительных результатов.
user_id	Необязательно	String	Выбор событий сообщений по кастомному User ID. См. /registerUser для получения дополнительной информации.
application_code	Обязательно	String	Выбор событий сообщений по коду Application Wavesend.
actions	Необязательно	Array	Фильтрация результатов по определенным действиям с сообщениями. Возможные значения: "sent", "delivered", "opened", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted".
platforms	Необязательно	Array	Массив целевых платформ для фильтрации результатов. Возможные значения: "ios", "android", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "huawei_android".

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

curl --location --request POST 'https://api.wavesend.ru/api/v2/statistics/getMessageLog' \
--header 'Authorization: Key API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "pagination_token": "PAGINATION_TOKEN_FROM_PREVIOUS_RESPONSE",  // необязательно, токен для пагинации
   "limit": 1000,                                  // необязательно, максимальное количество записей в одном ответе
   "application_code": "XXXXX-XXXXX",              // Код приложения Wavesend
   "message_code": "A444-AAABBBCC-00112233",       // необязательно, код сообщения, полученный из запроса /createMessage
   "message_id": 1234567890,                       // необязательно, ID сообщения, полученный из Wavesend Control Panel
   "campaign_code": "AAAAA-XXXXX",                 // необязательно, код Campaign, для которой нужно получить лог
   "hwid": "aaazzzqqqqxxx",                        // необязательно, HWID конкретного устройства, на которое было отправлено сообщение
   "user_id": "user_123",                          // необязательно, ID пользователя, которому было отправлено сообщение
   "date_from": "2000-01-25 00:00:00",             // необязательно, начало периода статистики
   "date_to": "2000-02-10 23:59:59",               // необязательно, конец периода статистики
   "actions": ["opened", "inbox_opened"],          // необязательно, используется для фильтрации результатов. Возможные значения: "sent", "opened", "delivered", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted". В ответ будут включены все сообщения с указанным(и) действием(ями).
   "platforms": ["ios", "chrome"]                  // необязательно, используется для фильтрации результатов. Возможные значения: "ios", "android", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "huawei android"
}'

Важно

Одно из следующих полей является обязательным: - message_id - message_code - campaign_code - hwid - user_id - date_from и date_to

Рассмотрите возможность применения различных параметров фильтрации, чтобы получить максимальную отдачу от статистики ваших сообщений.

Коды ответа и примеры

200: OK

{
  "pagination_token": "PAGINATION_TOKEN_FOR_NEXT_REQUEST",
  "data": [{
    "timestamp": "2000-01-25T11:18:47Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "sent",
    "status": "success",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:18:49Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "delivered",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:19:23Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "opened",
    "push_alerts_enabled": "true"
  }]
}

400: Некорректный запрос

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

401: Не авторизован

{
  "error": "account not found"
}

500: Внутренняя ошибка сервера

Note

Данные могут быть загружены за период не более 30 дней от текущего времени.

Tip

Для iOS убедитесь, что вы добавили Notification Service Extension в ваш проект для отслеживания доставки Push. Узнать больше

Статистика Email

linksInteractions

Отображает статистику по кликам на ссылки в Email.

POST https://api.wavesend.ru/api/v2/statistics/emails/linksInteractions

Заголовки

Название	Обязательно	Тип	Описание
Authorization	Да	String	Токен доступа к API из Wavesend Control Panel.

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

Название	Обязательно	Тип	Описание
date_range	Нет	Object	Определяет отчетный период. Содержит date_from и date_to.
filters	Да	Object	Фильтры Email.
application	Да	String	Код Application Wavesend (в качестве альтернативы укажите campaign, messages_ids или message_codes).
messages_codes	Да	Array	Коды сообщений (в качестве альтернативы укажите application, campaign или messages_ids).
campaign	Да	String	Код Campaign (в качестве альтернативы укажите application, messages_ids или message_codes).
messages_ids	Да	Array	ID сообщений (в качестве альтернативы укажите application, campaign или message_codes).
link_template	Обязательно, если указан application или campaign.	String	Фильтрует взаимодействия со ссылками в Email по ключевому слову. В ответе API будут возвращены только те ссылки, URL которых содержит указанный текст. Например, если ваше письмо содержит ссылки https://example.com/news и https://example.com/shop, установка "link_template": "shop" вернет взаимодействия только для https://example.com/shop.
email_content_code	Нет	String	Уникальный идентификатор контента Email.
params	Нет	Object	Определяет дополнительные параметры ответа. Включает with_full_links, который добавляет список полных ссылок со статистикой.

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

curl --location --request POST 'https://api.wavesend.ru/api/v2/statistics/emails/linksInteractions' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",           // Обязательный формат: 2000-01-01
         "date_to": "string"              // Обязательный формат: 2000-01-01
      },
      "campaign": "string",               // Код Campaign (вместо него можно указать application, messages_ids или message_codes)
      "application": "string",            // Код Application (вместо него можно указать campaign, messages_ids или message_codes)
      "messages_ids": [],                 // ID сообщений (вместо них можно указать application, campaign или message_codes)
      "messages_codes": [],               // Коды сообщений (вместо них можно указать application, campaign или message_ids)
      "link_template": "string",          // Шаблон ссылки (обязателен, если указан application или campaign)
      "email_content_code": "string"      // Уникальный идентификатор контента Email.
   },
   "params": {
      "with_full_links": true             // Укажите, нужно ли показывать подробную статистику. Список полных ссылок со статистикой будет передан в массиве full_links.
   }
}'

Коды ответа и примеры

200: OK

{
  "items": [{
    "template": "string",
    "link": "string",
    "title": "string",
    "clicks": 0,
    "full_links": [{
      "full_link": "string",
      "clicks": 0
    }]
  }]
}

400: Некорректный запрос

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

401: Не авторизован

{
  "error": "account not found"
}

500: Внутренняя ошибка сервера

linksInteractionsDevices

Показывает пользователей, которые кликнули по ссылкам в Email.

POST https://api.wavesend.ru/api/v2/statistics/emails/linksInteractionsDevices

Заголовки

Название	Обязательно	Тип	Описание
Authorization	Да	String	Токен доступа к API из Wavesend Control Panel.

---

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

Название	Обязательно	Тип	Описание
date_range	Нет	Object	Определяет отчетный период. Содержит date_from и date_to.
filters	Да	Object	Фильтры Email.
application	Да	String	Код Application Wavesend (в качестве альтернативы укажите campaign, messages_ids или message_codes).
messages_codes	Да	Array	Коды сообщений (в качестве альтернативы укажите application, campaign или messages_ids).
campaign	Да	String	Код Campaign (в качестве альтернативы укажите application, messages_ids или message_codes).
messages_ids	Да	Array	ID сообщений (в качестве альтернативы укажите application, campaign или message_codes).
link_template	Обязательно, если указан application или campaign.	String	Фильтрует взаимодействия со ссылками в Email по ключевому слову. В ответе API будут возвращены только те ссылки, URL которых содержит указанный текст. Например, если ваше письмо содержит ссылки https://example.com/news и https://example.com/shop, установка "link_template": "shop" вернет взаимодействия только для https://example.com/shop.
email_content_code	Нет	String	Уникальный идентификатор контента Email.
page	Нет	Integer	Номер страницы для пагинации.
per_page	Нет	Integer	Количество результатов на странице (≤ 1000).

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

curl --location --request POST 'https://api.wavesend.ru/api/v2/statistics/emails/linksInteractionsDevices' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",         // Обязательный формат: 2000-01-01
         "date_to": "string"            // Обязательный формат: 2000-01-01
      },
      "campaign": "string",             // Код Campaign (вместо него можно указать application, messages_ids или message_codes)
      "application": "string",          // Код Application (вместо него можно указать campaign, messages_ids или message_codes)
      "messages_ids": [],               // ID сообщений (вместо них можно указать application, campaign или message_codes)
      "messages_codes": [],             // Коды сообщений (вместо них можно указать application, campaign или message_ids)
      "link_template": "string",        // Шаблон ссылки (обязателен, если указан application или campaign)
      "email_content_code": "string"    // Уникальный идентификатор контента Email.
   },
   "per_page": 100,
   "page": 0
}'

Коды ответа и примеры

200: OK

{
  "total": 0,
  "items": [{
    "timestamp": "string",
    "link": "string",
    "hwid": "string"
  }]
}

400: Некорректный запрос

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

401: Не авторизован

{
  "error": "account not found"
}

500: Внутренняя ошибка сервера

bouncedEmails

POST https://api.wavesend.ru/api/v2/statistics/emails/bouncedEmails

Предоставляет данные о жалобах на Email, soft bounces и hard bounces, включая дату, адрес электронной почты и причину каждого возврата.

Авторизация

Авторизация осуществляется через API Access Token в заголовке запроса.

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

Имя параметра	Тип	Описание	Обязательно
application	string	Код Application Wavesend	Да
message_code	string	Код сообщения.	Обязательно, если не указаны date range или campaign
campaign	string	Код Campaign.	Обязательно, если не указаны message_code или date range
date_from	string	Дата начала для данных в формате ГГГГ-ММ-ДДTHH:MM:SS.000Z (стандарт ISO 8601).	Обязательно, если не указаны message_code или campaign
date_to	string	Дата окончания для данных в формате ГГГГ-ММ-ДДTHH:MM:SS.000Z (стандарт ISO 8601).	Обязательно, если не указаны message_code или campaign
per_page	int	Количество строк на странице, максимум 5000.	Да
page	int	Номер страницы, начиная с нуля.	Да
type	string	Тип возврата: Complaint, Softbounce, Hardbounce.	Нет

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

{
  "application": "XXXXX-XXXXX",               // обязательно. Код приложения Wavesend
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // обязательно, если не указаны campaign или диапазон дат.
                                              //          Уникальный идентификатор сообщения
  "campaign": "XXXXX-XXXXX",                  // обязательно, если не указаны message_code или диапазон дат.
                                              //          Код Campaign
  "date_from": "2024-07-20T00:00:00.000Z",    // обязательно, если не указаны message_code или campaign.
                                              //          Дата начала в формате ISO 8601 "ГГГГ-ММ-ДДTHH:MM:SS.SSSZ"
  "date_to": "2024-07-20T00:00:00.000Z",      // обязательно, если не указаны message_code или campaign.
                                              //          Дата окончания в формате ISO 8601 "ГГГГ-ММ-ДДTHH:MM:SS.SSSZ"
  "per_page": 1000,                           // обязательно. Количество результатов на странице, максимум 5000
  "page": 5,                                  // необязательно. Номер страницы, начиная с нуля
  "type": "Softbounce"                        // необязательно. Тип возврата: Complaint, Softbounce, Hardbounce
}

Поля ответа

Имя поля	Тип	Описание
total	int	Общее количество строк.
bounced_emails	array	Массив с деталями возвращенных Email.
├── email	string	Адрес электронной почты, с которого произошел возврат.
├── date	string	Дата возврата (формат: ГГГГ-ММ-ДДTHH:MM:SS.000Z).
├── reason	string	Причина возврата.
└── type	string	Тип возврата: Complaint, Softbounce, Hardbounce.

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

{
  "total": 25,                             // Общее количество строк.
  "bounced_emails": [{
    "email": "example@example.com",        // Адрес электронной почты, с которого произошел возврат
    "date": "2024-07-20T00:00:00.000Z",    // Дата возврата в формате ISO 8601
    "reason": "Invalid recipient address", // Причина возврата
    "type": "Hardbounce"                   // Тип возврата: Complaint, Softbounce, Hardbounce
  }]
}