SMS channel data dictionary

Here you'll find all the definitions and calculations of data fields used in the SMS channel dashboard.

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

Database field reference	Reporting field name	Type	Definition
carrier_name	Carrier name	string	Name of the carrier network used to deliver the SMS message
code	Code	string	The 10-digit SMS code used to send and receive SMS messages.
consent_action	Consent action	string	Mobile originated requested consent action: OPTED-IN, OPTED-OUT
contact_id	Contact ID	string	Customer identifier.
delivery_status	Delivery status	string	Status of delivery: SENT, REJECTED, ERROR, FAILED, DELIVERED, PARTIALLY_DELIVERED
event_date	Event date	datetime	Datetime of event.
event_hour	Event hour	datetime	Event datetime rounded to the corresponding top of hour.
event_category	Event ID	string	The channel category of the event.
event_details	Event DateTime	string	Details for this event.
event_type	Event type	string	Type of the email event.
is_mms_send	Is MMS send	string	Indicates whether the send includes media.
message_date	Message Date	time	Message send date UTC.
message_parts	Message parts	number	The number of parts in which the SMS message was split.
message_body	Message body	string	Mobile-originated message body.
mobile_number	Mobile number	string	Contact identifier of mobile device.
sent_event_date	Sent	datetime	The first sent event of the message.
sent_event_datetime	Sent date (formatted)	datetime	The first sent event of the message formatted as 'Month Date, Year'.
sms_provider	SMS provider	string	SMS publishing service name.

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'.

Database field reference	Reporting field name	Definition
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

**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

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 an abbreviated month. Includes other datetime elements of the Message. e.g. Apr 04, 2022, 02:18 PM	sms_delivered_time.view