Parameters
Database field reference | Reporting field name | Type | Definition |
---|---|---|---|
select_metric | Select Metric | string | Filter associated with an SMS's event type. |
Event Types | |||
Clicks (Gross), Clicks (Unique), Interacted, Sent |
Dimensions
Database field reference | Reporting field name | Type | Definition |
---|---|---|---|
camp_name | Campaign name | string | Name of the associated campaign, free form text |
carrier_name | Carrier name | string | Name of the carrier networked used to deliver the SMS message |
consent_action | Consent action | string | Mobile originated requested consent action: OPTED-IN, OPTED-OUT |
delivery_status | Delivery status | string | Status of delivery: SENT, REJECTED, ERROR, FAILED, DELIVERED, PARTIALLY_DELIVERED |
event_date | Event Date | datetime | Datetime of event. |
event_category | Event category | string | Event Category |
event_datetime | Event DateTime | string | Converts the month to abbreviated month. Includes other datetime elements of Event. e.g. 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 | time | Message Send Date UTC |
message_datetime | Message DateTime | time | Converts the month to abbreviated month. Includes other datetime elements of Message. e.g. Apr 04, 2022, 02:18 PM |
message_parts | Message parts | number | Number of parts in which the SMS message was split |
mo_message_body | Message body | string | Mobile originated message body |
mobile_number | Mobile number | string | Contact Identifier of mobile device |
mo_mobile_number | Message number | string | Mobile originated message, number of the mobile device |
msg_name | Message name | string | Extracted from 'SOURCE' field |
should_process | Should process | string | Extracted from 'SOURCE' field |
sms_code | Sms code | string | The 10 digit sms code used to send and receive sms messages |
sms_provider | Sms provider | string | SMS Publishing Service Name |
Measures
Database field reference |
Reporting field name |
Type |
Definition |
Calculations |
---|---|---|---|---|
count |
Count |
Count |
The total number of SMS events by event_id. |
Count of event_id records. |
click_count |
Clicked (gross) |
count |
The total number of clicks. |
Count of events with event_type: 'smsClick'. |
click_count_unique |
Clicked (unique) |
count_distinct |
The total number of unique clicks |
Count of unique contact_ids by message_id with one click count. |
click_rate |
Clicked rate (gross) |
number |
The total number of click events out of the number of delivered messages. |
Click count out of the delivery count, by percentage. |
click_rate_unique |
Clicked rate (unique) |
number |
The total number of unique clicks out a number of delivered events, as a percentage. |
Unique click count out of delivery count, by percentage. |
delivery_count |
Delivered |
count |
The total number of times an SMS message was not rejected by a server. |
Count of events with event_type: 'deliveredSMS'. |
undelivery_count |
Failed delivery |
count |
The total number of sent message that were undelivered. |
Count of events with delivery_status: 'FAILED'. |
undelivery_rate |
Failed delivery rate |
number |
The total number of failed delivery count by a number of sent events, as a percentage. |
Failed delivery count out of sent count, by percentage. |
interacted_count |
Interacted |
count |
The total number of interacted messages. |
Count of events with event_type: 'interactedSMS'. |
send_count |
Sent |
count |
The total number of times an SMS message is sent to a recipient in a marketing campaign. |
Count of events with event_type: 'sentSMS'. |
Dynamic measures
Database field reference |
Reporting field name |
Definition |
Calculations |
---|---|---|---|
dynamic_metric |
Dynamic measure |
Aggregate associated with 'select_metric' filter |
Getting the count of a selected sms’s event type from 'select_metric' filter |
Event Types |
|||
click_count, click_unique_count, sent_count, interacted_count |
Dynamic event datetime dimensions
**Associated with SMS event type parameter**
Database field reference |
Reporting field name | Definition | View |
---|---|---|---|
Max per Metric Event |
max_per_metric_event |
The max datetime of event associated with 'select_metric' filter |
sms_per_metric_time.view |
Max per Metric Event Datetime |
max_per_metric_event_datetime |
Converts the month to abbreviated month. Includes other datetime elements of Message. e.g. Apr 04, 2022, 02:18 PM |
sms_per_metric_time.view |
Event datetime dimensions
Database field reference |
Reporting field name |
Type |
Definition |
View |
---|---|---|---|---|
Send | message_date | datetime | The datetime of a send event. | sms_send_time.view |
Send DateTime | message_date_datetime | string | Converts the month to an abbreviated month. Includes other datetime elements of Message. e.g. Apr 04, 2022, 02:18 PM |
sms_send_time.view |
Delivered | message_date | datetime | The datetime of a delivered event. | sms_delivered_time.view |
Delivered Datetime | message_date_datetime | string | Converts the month to abbreviated month. Includes other datetime elements of the Message.
e.g. Apr 04, 2022, 02:18 PM |
sms_delivered_time.view |
Comments
0 comments
Please sign in to leave a comment.