Перейти к содержанию

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

messages:list

Anchor link to

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

POST https://api.pushwoosh.com/api/v2/messages:list

Заголовки
Anchor link to
Название
Обязательный
Тип
Описание
AuthorizationДаStringТокен доступа к API из Панели управления Pushwoosh.
Параметры запроса
Anchor link to
Название
Обязательный
Тип
Описание
platformsНетArrayПлатформы сообщений. Возможные значения: "IOS", "ANDROID", "OSX", "WINDOWS", "AMAZON", "SAFARI", "CHROME", "FIREFOX", "IE", "EMAIL", "HUAWEI_ANDROID", "SMS".
date_rangeНетObjectОтчетный период. date_from и date_to должны соответствовать формату YYYY-MM-DD (например, "2000-01-01").
campaignНетStringКод кампании.
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НетArrayID сообщений, полученные из истории сообщений.
paramsНетObjectУкажите, нужно ли показывать детали и метрики сообщения. Установите with_details: true, чтобы включить объект "details", и with_metrics: true, чтобы включить объект "metrics" в ответ.
applicationДаStringКод приложения Pushwoosh.
per_pageНетIntegerКоличество результатов на странице (≤ 1000).
pageНетIntegerНомер страницы для пагинации.
Пример запроса
Anchor link to
{
"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", // Код кампании
"messages_ids": [], // ID сообщений
"messages_codes": [], // Коды сообщений
"application": "string" // Код приложения Pushwoosh
},
"params": {
"with_details": true, // Добавить детали сообщения в ответ (объект "details")
"with_metrics": true // Добавить метрики сообщения в ответ (объект "metrics")
},
"per_page": 20, // <= 1000
"page": 0
}
Коды ответа и примеры
{
"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
}]
}
}]
}

totalsByIntervals

Anchor link to

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

POST https://api.pushwoosh.com/api/v2/statistics/messages/totalsByIntervals

Авторизация
Anchor link to

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

Параметры запроса
Anchor link to
Имя параметра
Тип
ОписаниеОбязательный
message_codestringКод сообщения, полученный из ответов API /createMessage.Да
platforms[int]ПлатформыНет
Пример запроса
Anchor link to
{
"message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // обязательный. Уникальный идентификатор сообщения
"platforms": [1, 3, 7, 10, 11, 12] // необязательный. Список кодов платформ
}
Поля ответа
Anchor link to
НазваниеТипОписание
metricsarrayСодержит массив метрик сообщения
timestampstringВремя метрики.
platformintКод платформы (например, iOS, Android).
sendsstringКоличество отправленных сообщений.
opensstringКоличество открытых сообщений.
deliveriesstringКоличество доставленных сообщений.
inbox_opensstringКоличество открытий в Message Inbox.
unshowable_sendsstringКоличество отправленных сообщений, которые не могли быть показаны.
errorsstringКоличество ошибок.
conversionobjectСодержит данные о конверсии
sendsstringОбщее количество отправленных сообщений.
opensstringОбщее количество открытых сообщений.
eventsarrayМассив событий с их статистикой
namestringНазвание события (например, cart_add).
hitsstringКоличество хитов.
conversionfloatКоэффициент конверсии относительно открытий.
revenuefloatДоход (только для событий с атрибутами __amount и __currency).
Пример ответа
Anchor link to
{
"metrics": [{
"timestamp": "2024-08-03 15:00:00", // Временная метка метрик в формате "YYYY-MM-DD HH:MM:SS"
"platform": 3, // Код платформы
"sends": "55902", // Количество отправленных сообщений
"opens": "382", // Количество открытых сообщений
"deliveries": "22931", // Количество доставленных сообщений
"inbox_opens": "0", // Количество сообщений, открытых в Message Inbox
"unshowable_sends": "2", // Количество сообщений, которые не удалось показать
"errors": "0" // Количество возникших ошибок
}],
"conversion": {
"sends": "55902", // Общее количество отправленных сообщений
"opens": "772", // Общее количество открытых сообщений
"events": [{
"name": "cart_add", // Название события
"hits": "96", // Количество хитов для события
"conversion": 0.12, // Коэффициент конверсии относительно открытий
"revenue": 0 // Доход, сгенерированный событием (только для событий с атрибутами amount/currency)
}]
}
}

getMessageLog

Anchor link to

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

POST https://api.pushwoosh.com/api/v2/statistics/getMessageLog

Заголовки
Anchor link to
Название
Обязательный
Тип
Описание
AuthorizationОбязательныйStringТокен доступа к API из Панели управления Pushwoosh.
Параметры тела запроса
Anchor link to
Название
Обязательный/Необязательный
Тип
Описание
message_idНеобязательныйIntegerВыбор событий сообщений по ID сообщения, полученному из истории сообщений. Пример: 12345678900.
message_codeНеобязательныйStringВыбор событий сообщений по коду сообщения, полученному из ответов API /createMessage. Пример: "A444-AAABBBCC-00112233".
campaign_codeНеобязательныйStringВыбор событий сообщений по коду кампании, указанному в теле вашего сообщения. Пример: "AAAAA-XXXXX".
hwidНеобязательныйString or ArrayВыбор событий сообщений по HWID (аппаратному идентификатору) или массиву HWID.
date_fromОбязателен, если не указаны message_id, message_code или campaign_codeDatetimeДата начала для фильтрации сообщений. Формат: "YYYY-MM-DD HH:MM:SS". Пример: "2000-01-25 00:00:00".
date_toОбязателен, если не указаны message_id, message_code или campaign_codeDatetimeДата окончания для фильтрации сообщений. Формат: "YYYY-MM-DD HH:MM:SS". Пример: "2000-01-26 00:00:00".
limitНеобязательныйIntegerМаксимальное количество событий сообщений, возвращаемых в одном ответе. Максимальное значение: 100000.
pagination_tokenНеобязательныйStringТокен пагинации, полученный из предыдущего ответа /getMessageLog. Используйте его для получения дополнительных результатов.
user_idНеобязательныйStringВыбор событий сообщений по кастомному ID пользователя. См. /registerUser для получения дополнительной информации.
application_codeОбязательныйStringВыбор событий сообщений по коду приложения Pushwoosh
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".
Пример запроса
Anchor link to
Terminal window
curl --location --request POST 'https://api.pushwoosh.com/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", // код приложения Pushwoosh
"message_code": "A444-AAABBBCC-00112233", // необязательный, код сообщения, полученный из запроса /createMessaage
"message_id": 1234567890, // необязательный, ID сообщения, полученный из Панели управления Pushwoosh
"campaign_code": "AAAAA-XXXXX", // необязательный, код кампании, для которой нужно получить лог
"hwid": "aaazzzqqqqxxx", // необязательный, аппаратный ID конкретного устройства, на которое было отправлено сообщение
"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"
}'
Коды ответа и примеры
{
"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"
}]
}

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

Anchor link to

linksInteractions

Anchor link to

Отображает статистику по кликам на ссылки в email-сообщениях

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions

Заголовки
Anchor link to
Название
Обязательный
ТипОписание
AuthorizationДаStringТокен доступа к API из Панели управления Pushwoosh.
Параметры запроса
Anchor link to
Название
Обязательный
ТипОписание
date_rangeНетObjectОпределяет отчетный период. Содержит date_from и date_to.
filtersДаObjectФильтры email-сообщений.
applicationДаStringКод приложения Pushwoosh (в качестве альтернативы укажите campaign, messages_ids или message_codes).
messages_codesДаArrayКоды сообщений (в качестве альтернативы укажите application, campaign или messages_ids).
campaignДаStringКод кампании (в качестве альтернативы укажите application, messages_ids или message_codes).
messages_idsДаArrayID сообщений (в качестве альтернативы укажите 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, который добавляет список полных ссылок со статистикой.
Пример запроса
Anchor link to
Terminal window
curl --location --request POST 'https://api.pushwoosh.com/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", // Код кампании (вместо него можно указать application, messages_ids или message_codes)
"application": "string", // Код приложения (вместо него можно указать 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.
}
}'
Коды ответа и примеры
Anchor link to
{
"items": [{
"template": "string",
"link": "string",
"title": "string",
"clicks": 0,
"full_links": [{
"full_link": "string",
"clicks": 0
}]
}]
}

linksInteractionsDevices

Anchor link to

Показывает пользователей, которые кликнули на ссылки в email-сообщениях

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices

Заголовки
Anchor link to
Название
Обязательный
ТипОписание
AuthorizationДаStringТокен доступа к API из Панели управления Pushwoosh.

Параметры запроса
Anchor link to
Название
Обязательный
ТипОписание
date_rangeНетObjectОпределяет отчетный период. Содержит date_from и date_to.
filtersДаObjectФильтры email-сообщений.
applicationДаStringКод приложения Pushwoosh (в качестве альтернативы укажите campaign, messages_ids или message_codes).
messages_codesДаArrayКоды сообщений (в качестве альтернативы укажите application, campaign или messages_ids).
campaignДаStringКод кампании (в качестве альтернативы укажите application, messages_ids или message_codes).
messages_idsДаArrayID сообщений (в качестве альтернативы укажите 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).
Пример запроса
Anchor link to
Terminal window
curl --location --request POST 'https://api.pushwoosh.com/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", // Код кампании (вместо него можно указать application, messages_ids или message_codes)
"application": "string", // Код приложения (вместо него можно указать 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
}'
Коды ответа и примеры
Anchor link to
{
"total": 0,
"items": [{
"timestamp": "string",
"link": "string",
"hwid": "string"
}]
}

bouncedEmails

Anchor link to

POST https://api.pushwoosh.com/api/v2/statistics/emails/bouncedEmails

Предоставляет данные о жалобах на email, временных и постоянных ошибках доставки, включая дату, email-адрес и причину каждой ошибки.

Авторизация
Anchor link to

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

Параметры запроса
Anchor link to
Имя параметраТипОписаниеОбязательный
applicationstringКод приложения PushwooshДа
message_codestringКод сообщения.Обязателен, если не указаны date range или campaign
campaignstringКод кампании.Обязателен, если не указаны message_code или date range
date_fromstringДата начала для данных в формате YYYY-MM-DDTHH:MM:SS.000Z (стандарт ISO 8601).Обязателен, если не указаны message_code или campaign
date_tostringДата окончания для данных в формате YYYY-MM-DDTHH:MM:SS.000Z (стандарт ISO 8601).Обязателен, если не указаны message_code или campaign
per_pageintКоличество строк на странице, максимум 5000.Да
pageintНомер страницы, начиная с нуля.Да
typestringТип ошибки доставки: Complaint, Softbounce, Hardbounce.Нет
Пример запроса
Anchor link to
{
"application": "XXXXX-XXXXX", // обязательный. Код приложения Pushwoosh
"message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // обязательный, если не указаны кампания или диапазон дат.
// Уникальный идентификатор сообщения
"campaign": "XXXXX-XXXXX", // обязательный, если не указаны message_code или диапазон дат.
// Код кампании
"date_from": "2024-07-20T00:00:00.000Z", // обязательный, если не указаны message_code или campaign.
// Дата начала в формате ISO 8601 "YYYY-MM-DDTHH:MM:SS.SSSZ"
"date_to": "2024-07-20T00:00:00.000Z", // обязательный, если не указаны message_code или campaign.
// Дата окончания в формате ISO 8601 "YYYY-MM-DDTHH:MM:SS.SSSZ"
"per_page": 1000, // обязательный. Количество результатов на странице, максимум 5000
"page": 5, // необязательный. Номер страницы, начиная с нуля
"type": "Softbounce" // необязательный. Тип ошибки доставки: Complaint, Softbounce, Hardbounce
}
Поля ответа
Anchor link to
Название поляТипОписание
totalintОбщее количество строк.
bounced_emailsarrayМассив с деталями по недоставленным email.
├── emailstringEmail-адрес, на который не удалось доставить сообщение.
├── datestringДата ошибки доставки (формат: YYYY-MM-DDTHH:MM:SS.000Z).
├── reasonstringПричина ошибки доставки.
└── typestringТип ошибки доставки: Complaint, Softbounce, Hardbounce.
Пример ответа
Anchor link to
{
"total": 25, // Общее количество строк.
"bounced_emails": [{
"email": "example@example.com", // Email-адрес, на который не удалось доставить сообщение
"date": "2024-07-20T00:00:00.000Z", // Дата ошибки доставки в формате ISO 8601
"reason": "Invalid recipient address", // Причина ошибки доставки
"type": "Hardbounce" // Тип ошибки доставки: Complaint, Softbounce, Hardbounce
}]
}