How do I retrieve statistics and open rates for iOS Inbox messages?

The Pushwoosh Control Panel dashboard charts do not display iOS Inbox message statistics. However, you can get this data by using the Pushwoosh Statistics API.

Get inbox statistics with the API

Use the getMessageLog API method to pull statistics for any period up to 30 days.

• Endpoint: POST https://api.pushwoosh.com/api/v2/statistics/getMessageLog
• Inbox actions: pass the actions you need in the request payload, for example "actions": ["inbox_delivered"], ["inbox_read"], ["inbox_opened"] or ["inbox_deleted"].
• Filtering options: you can filter the query by message_id, message_code, campaign_code, hwid, user_id, or a date_from/date_to range. At least one of these is required.

Calculate the inbox open rate

A push notification is stored in the App Inbox only when Inbox storage is enabled for it — turn on Save to inbox in the Push notification element of your Customer Journey (or use the inbox_date / inbox_days parameters in the API). Deliveries that were not saved to the Inbox are not counted in Inbox statistics.

Because of that, calculate the open rate against inbox deliveries, not against all push deliveries:

Inbox Open Rate (%) = (Unique inbox_opened / inbox_delivered) * 100

For the full list of parameters, see the Pushwoosh Message Statistics API documentation.