select_metric

Select Metric

string

Filter associated with a mobile's event type.

Event types

simple_sent, simple_url_clicked_gross, simple_url_clicked_unique, inbox_url_clicked_gross, inbox_url_clicked_unique, inbox_messages_sent, inapp_messages_sent, simple_app_opens, simple_phone_number_clicks, simple_inbox_message_opens

action_taken

Action taken

string

The way the user interacted with the notification they viewed.
'dial', 'app', 'url', 'inbox' or 'read'

action_value

Action value

string

The action that was taken resulting in the app being opened.

custom_data_1

Custom data 1

string

Customer-defined event data

custom_data_2

Custom data 2

string

Customer-defined event data

custom_data_3

Custom data 3

string

Customer-defined event data

custom_data_other

Custom data other

string

Customer-defined event data

event_date

Event Date

datetime

The datetime of an event.

event_category

Event category

string

Event Category

event_datetime

Event DateTime

string

Converts the month to an abbreviated month. Includes other datetime elements of the Event.

ex. Apr 04, 2022, 02:18 PM

event_details

Event details

string

Details for this event

event_type

Event type

string

Type of the email event

message_date

Message Date

datetime

Message send date

message_datetime

Message DateTime

string

Converts the month to an abbreviated month. Includes other datetime elements of the Event.

ex. Apr 04, 2022, 02:18 PM

push_certified

Push certified

boolean

Push Delivery Status, enabled or not

push_origin

Push origin

string

Push Delivery Origin: [ PROVIDER, SYNC ]

push_state

Push state

string

State of push.
displayed, expired, silent, disabled, dropped, failed

push_type

Push type

string

Type of notifications.
simple, inbox, inApp, watch

session_end_date

Session End Date

datetime

Time the session ended

session_end_datetime

Session End DateTime

string

Converts the month to an abbreviated month. Includes other datetime elements of the Message.

ex. Apr 04, 2022, 02:18 PM

session_start_date

Session Start Date

datetime

Time the session began

session_start_datetime

Session Start DateTime

string

Converts the month to an abbreviated month. Includes other datetime elements of the Message.

ex. Apr 04, 2022, 02:18 PM

avg_device_count

Avg # devices per contact

number

The average number of devices by contact.

Device_id count out of contact_id count.

action_gross

Actions (gross)

count

The total number of actions taken as a result of push notifications. The number includes app open clicks, URL clicks, and phone number clicks.

Count of events with an action_taken.

action_rate_gross

Actions rate (gross)

number

The rate of actions taken.

Action gross count out of send count, by percentage.

action_unique

Actions (unique)

count_distinct

count

Count

count

Total number of events

Count of event_id records.

certified_messages_sent

Certified messages sent

count

The total number of certified notifications delivered. This number includes notifications delivered to devices that disabled push notifications.

Count of events with push_certified: '1' and event_type: 'mobilePushSend'.

data_messages_sent

Data messages sent

count

The total number of times data messages are sent.

Count of events that is push_type: 'data', event_type: 'mobilePushSend'.

inapp_action_gross

InApp actions (gross)

count

The total number of inApp actions taken.

Count of events with push_type: 'inApp', action_taken: '-NULL'.

inapp_action_rate

Inapp actions rate

number

The rate of inapp actions taken.

Inapp actions count out of send count, by percentage.

inapp_action_unique

Inapp actions unique

count_distinct

Count of unique contact_ids by message_id with one inapp action.

Count of unique contact_ids by message_id with one inapp_action_gross count.

inapp_action_rate_unique

InApp action rate (unique)

number

The rate of inApp actions taken.

Count of Inapp actions out of send count, by percentage.

inapp_messages_sent

InApp messages sent

count

The total number of times InApp messages were sent, including messages sent to devices that disabled push notifications.

Count of events with push_type: 'inApp', event_type: 'mobilePushSend'.

inbox_action_gross

Inbox actions (gross)

count

The total number of actions taken as a result of inbox push notifications.

Count of events with push_type: 'inbox', action_taken: '-NULL'.

inbox_action_rate

Inbox actions rate

number

The rate of inbox actions taken.

Inbox actions count out of send count, by percentage.

inbox_action_unique

Inbox actions unique

count_distinct

Count of unique contact_ids by message_id with one inbox action.

Count of unique contact_ids by message_id with one inbox_action_gross count.

inbox_action_rate_unique

Inbox action rate (unique)

number

The total number of unique inbox actions out of send count, as a percentage.

Unique inbox actions count out of send count, by percentage.

inbox_messages_sent

Inbox messages sent

count

The total number of times inbox messages were sent, including messages sent to devices that disabled push notifications.

Count of events with push_type: ‘inbox', event_type: 'mobilePushSend’.

inbox_url_click_gross

Inbox URL clicked (gross)

count

The total number of inbox URL clicks.

Count of events with push_type: 'inbox', action_taken: 'url', event_type: 'appNotificationOpen'.

inbox_url_click_unique

Inbox URL clicked (unique)

count_distinct

Count of unique contact_ids by message_id with one inbox_url action.

Count of unique contact_ids by message_id with one inbox_url_click_gross count.

inbox_url_click_rate_unique

Inbox URL click rate (unique)

number

The total number of unique inbox URL clicks out of send count, as a percentage.

Unique inbox URL clicks count out of send count, by percentage.

installed_count

Installed

count

The total number of times a user installed the mobile app on their device.

Count of events with event_type: 'appInstalled'.

mobile_click_count

Mobile clicks

count

The total number of times a recipient clicked a link within a mobile message.

Count of events with
action_taken: 'URL'.

mobile_open_count

Mobile opens

count

The total number of times a recipient opened a mobile message.

Count of events with
action_taken: 'read, inbox, app, dial'.

push_enabled_count

Push enabled

count

The total number of times push notifications were enabled on a device.

Count of events with
event_type: 'appPushEnabled'.

push_disabled_count

Push disabled

count

The total number of times push notifications were disabled on a device.

Count of events with
event_type: 'appPushDisabled'.

send_count

Sent

count

The total number of times a mobile message is sent to a recipient in a marketing campaign.

Count of events with event_type: ‘mobilePushSend’.

simple_total_count

Simple: All actions (gross)

count

The total number of times actions were taken as a result of push notifications. The number includes app open clicks, URL clicks, and phone number clicks.

Count of events with action_taken: '-NULL', push_type: 'simple'.

simple_unique_total

Simple: All actions (unique)

count_distinct

Count of unique contact_ids by message_id with one simple push_type.

Count of unique contact_ids by message_id with one simple_total count.

simple_action_rate_unique

Simple action rate (unique)

count_distinct

The total number of unique simple push types out of send count, as a percentage.

simple_unique_total count out of send count, by percentage.

simple_url_clicks_gross

Simple: URL clicks (gross)

count

The total number of times a user clicked on a URL in a notification.

Count of events with action_taken: 'URL', push_type: 'simple', event_type: 'appNotificationOpen'.

simple_url_clicks_unique

Simple: URL clicks (unique)

count_distinct

Count of unique contact_ids by message_id with one simple push_type and one URL action.

Count of unique contact_ids by message_id with one simple push_type and simple_url_clicks_gross count.

simple_clicked_rate_unique

Simple clicked rate (unique)

number

The total number of unique simple URL clicks by the number of delivered events, as a percentage.

simple_url_clicks_unique out of send count, by percentage.

simple_phone_number_clicks

Simple: phone number clicks

count

The total number of times a user clicked on "dial" in a notification.

Count of events with action_taken: 'dial', push_type: 'simple', event_type: 'appNotificationOpen'.

simple_app_opens

Simple: app opens

count

The total number of times a user clicked on the "openApp" in a notification.

Count of events with action_taken: 'app', push_type: 'simple', event_type: 'appNotificationOpen'.

simple_inbox_message_opens

Simple: inbox message opens

count

The total number of times a user clicked on "openInboxMessage" in a notification.

Count of events with action_taken: 'inbox', push_type: 'simple', event_type: 'appNotificationOpen'.

simple_dropped

Simple: dropped

count

The total number of times notifications were not sent to the mobile provider (APNS, FCM). 

Count of events with push_type: 'simple', event_type: 'dropped'.

simple_expired

Simple: expired

count

The total number of times notifications were not sent within the default time period of 24 hours, or as configured per organization.

Count of events with push_type: 'simple', event_type: 'expired'.

simple_failed

Simple: failed

count

The total number of times a recipient sees an error instead of the notification.

Count of events with push_type: 'simple', event_type: 'failed'.

simple_received

Simple: received

count

The total number of times notifications were received by the mobile provider (APNS, FCM).

Count of events with push_type: 'simple', event_type: 'received'.

simple_sent

Simple: sent

count

The total number of times notifications were sent to the mobile provider (APNS, FCM).

Count of events with push_type: 'simple', event_type: 'mobilePushSend'.

watch_messages_sent

Watch messages sent

count

The total number of times watch messages were sent.

Count of events with push_type: 'watch', event_type: 'mobilePushSend'.

dynamic_metric

Dynamic measure

Aggregate associated with 'select_metric' filter.

count of a selected email's event type from the select_metric filter.

simple_sent, simple_url_clicked_gross, simple_url_clicked_unique, inbox_url_clicked_gross, inbox_url_clicked_unique, inbox_messages_sent, inapp_messages_sent, simple_app_opens, simple_phone_number_clicks, simple_inbox_message_opens

Last action Date

max_per_metric_event

The max datetime of an event associated with the 'select_metric' filter

mobile_per_metric_time.view

Last action DateTime

max_per_metric_event_datetime

Converts the month to an abbreviated month. Includes other datetime elements of the Message.

e.g. Apr 04, 2022, 02:18 PM

mobile_per_metric_time.view