Here you'll find all the definitions and calculations of data fields used in the SMS channel dashboard.
Parameters
| Reporting field name | Type | Definition |
|---|---|---|
| Select Metric | string | Filter associated with an SMS's event type. |
| Event Types | ||
| Clicks gross, Clicks unique, Interacted, Sent |
Dimensions
| Reporting field name | Type | Definition |
|---|---|---|
| Carrier name | string | Name of the carrier network used to deliver the SMS message |
| Code | string | The 10-digit SMS code used to send and receive SMS messages. |
| Consent action | string | Mobile originated requested consent action: OPTED-IN, OPTED-OUT |
| Contact ID | string | Customer identifier. |
| Delivery status | string | Status of delivery: SENT, REJECTED, ERROR, FAILED, DELIVERED, PARTIALLY_DELIVERED |
| Event date | datetime | Datetime of event. |
| Event hour | datetime | Event datetime rounded to the corresponding top of the hour. |
| Event ID | string | The channel category of the event. |
| Event DateTime | string | Details for this event. |
| Event type | string | Type of the email event. |
| Is MMS send | string | Indicates whether the send includes media. |
| Message Date | time | Message send date UTC. |
| SMS message ID | string | ID of the message. |
| Message occurrence ID | string | ID that is based on the message_id and changes per occurrence of this message_id. |
| Message parts | number | The number of parts in which the SMS message was split. |
| Message body | string | Mobile-originated message body. |
| Mobile number | string | Contact identifier of mobile device. |
| Sent | datetime | The first sent event of the message. |
| Sent date (formatted) | datetime | The first sent event of the message formatted as 'Month Date, Year'. |
| SMS provider | string | SMS publishing service name. |
Measures
| Reporting field name | Type | Definition | Calculations |
|---|---|---|---|
|
Count |
Count |
The number of SMS events by event_id. |
Count of event_id records. |
|
Clicked gross |
count |
The number of clicks. |
Count of events with event_type: 'smsClick'. |
|
Clicked unique |
count_distinct |
The number of unique clicks |
Count of unique contact_ids by message_id with one click count. |
|
Clicked rate gross |
number |
The number of click events out of the number of delivered messages. |
Click count out of the delivery count, by percentage. |
|
Clicked rate unique |
number |
The number of unique clicks out a number of delivered events, as a percentage. |
Unique click count out of delivery count, by percentage. |
|
Delivered |
count |
The number of times an SMS message was not rejected by a server. |
Count of events with event_type: 'deliveredSMS'. |
|
Expired gross |
count |
The number of SMS messages marked as expired because the aggregator did not pick them up or failed to confirm pickup. These messages are not counted as sends or failures. |
Count of events with eventType='sent' and deliveryStatus='EXPIRED'. |
|
Expired parts gross |
count |
The number of SMS message parts marked as expired due to the aggregator not picking them up or failing to confirm pickup. These message parts are not counted as sends or failures. |
Sum of message parts across the SMS events with eventType='sent' and deliveryStatus='EXPIRED' |
|
Undelivered |
count |
The number of sent message that were undelivered. |
Count of events with delivery_status: 'FAILED'. |
|
Undelivered rate |
number |
The 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 |
The number of interacted messages. |
Count of events with event_type: 'interactedSMS'. |
|
Sent |
count |
The number of times an SMS message is sent to a recipient in a marketing campaign. |
Count of events with event_type: 'sentSMS'. |
Event datetime dimensions
| Database field reference | Type | Definition | View |
|---|---|---|---|
| Delivered | datetime | The datetime of a delivered event. | sms_delivered_time.view |
| Delivered DateTime | string | Converts the month to an abbreviated month. Includes other datetime elements of the Message.
e.g. Apr 04, 2022, 02:18 PM |
sms_delivered_time.view |
| Max per Metric Event | The max datetime of an event associated with 'select_metric' filter | sms_per_metric_time.view | |
| 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 | |
| Send | datetime | The datetime of a send event. | sms_send_time.view |
| Send 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 |