Статистика сообщений
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 | Нет | Array | ID сообщений, полученные из истории сообщений. |
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 }] } }]}
{ "error": "exceeded the maximum date interval. Max interval: 30 days"}
{ "error": "account not found"}
totalsByIntervals
Anchor link toВозвращает метрики и данные о конверсиях на основе кода сообщения, сгруппированные по часам.
POST https://api.pushwoosh.com/api/v2/statistics/messages/totalsByIntervals
Авторизация
Anchor link toАвторизация осуществляется через токен доступа к API в заголовке запроса.
Параметры запроса
Anchor link toИмя параметра | Тип | Описание | Обязательный |
---|---|---|---|
message_code | string | Код сообщения, полученный из ответов API /createMessage . | Да |
platforms | [int] | Платформы | Нет |
Пример запроса
Anchor link to{ "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // обязательный. Уникальный идентификатор сообщения "platforms": [1, 3, 7, 10, 11, 12] // необязательный. Список кодов платформ}
Поля ответа
Anchor link toНазвание | Тип | Описание |
---|---|---|
metrics | array | Содержит массив метрик сообщения |
timestamp | string | Время метрики. |
platform | int | Код платформы (например, iOS, Android). |
sends | string | Количество отправленных сообщений. |
opens | string | Количество открытых сообщений. |
deliveries | string | Количество доставленных сообщений. |
inbox_opens | string | Количество открытий в Message Inbox. |
unshowable_sends | string | Количество отправленных сообщений, которые не могли быть показаны. |
errors | string | Количество ошибок. |
conversion | object | Содержит данные о конверсии |
sends | string | Общее количество отправленных сообщений. |
opens | string | Общее количество открытых сообщений. |
events | array | Массив событий с их статистикой |
name | string | Название события (например, cart_add). |
hits | string | Количество хитов. |
conversion | float | Коэффициент конверсии относительно открытий. |
revenue | float | Доход (только для событий с атрибутами __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_code | Datetime | Дата начала для фильтрации сообщений. Формат: "YYYY-MM-DD HH:MM:SS" . Пример: "2000-01-25 00:00:00" . |
date_to | Обязателен, если не указаны message_id , message_code или campaign_code | Datetime | Дата окончания для фильтрации сообщений. Формат: "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 tocurl --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" }]}
{ "error": "exceeded the maximum date interval. Max interval: 30 days"}
{ "error": "account not found"}
Статистика email-сообщений
Anchor link tolinksInteractions
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 | Да | 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 , который добавляет список полных ссылок со статистикой. |
Пример запроса
Anchor link tocurl --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 }] }]}
{ "error": "exceeded the maximum date interval. Max interval: 30 days"}
{ "error": "account not found"}
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 | Да | 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). |
Пример запроса
Anchor link tocurl --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" }]}
{ "error": "exceeded the maximum date interval. Max interval: 30 days"}
{ "error": "account not found"}
bouncedEmails
Anchor link toPOST https://api.pushwoosh.com/api/v2/statistics/emails/bouncedEmails
Предоставляет данные о жалобах на email, временных и постоянных ошибках доставки, включая дату, email-адрес и причину каждой ошибки.
Авторизация
Anchor link toАвторизация осуществляется через токен доступа к API в заголовке запроса.
Параметры запроса
Anchor link toИмя параметра | Тип | Описание | Обязательный |
---|---|---|---|
application | string | Код приложения Pushwoosh | Да |
message_code | string | Код сообщения. | Обязателен, если не указаны date range или campaign |
campaign | string | Код кампании. | Обязателен, если не указаны message_code или date range |
date_from | string | Дата начала для данных в формате YYYY-MM-DDTHH:MM:SS.000Z (стандарт ISO 8601). | Обязателен, если не указаны message_code или campaign |
date_to | string | Дата окончания для данных в формате YYYY-MM-DDTHH:MM:SS.000Z (стандарт ISO 8601). | Обязателен, если не указаны message_code или campaign |
per_page | int | Количество строк на странице, максимум 5000. | Да |
page | int | Номер страницы, начиная с нуля. | Да |
type | string | Тип ошибки доставки: 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Название поля | Тип | Описание |
---|---|---|
total | int | Общее количество строк. |
bounced_emails | array | Массив с деталями по недоставленным email. |
├── email | string | Email-адрес, на который не удалось доставить сообщение. |
├── date | string | Дата ошибки доставки (формат: YYYY-MM-DDTHH:MM:SS.000Z ). |
├── reason | string | Причина ошибки доставки. |
└── type | string | Тип ошибки доставки: 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 }]}