SMS Event Stream Data Sets

The following data sets are available through SMS Event Stream. To set up your S3 bucket policy, see the Event Stream S3 Bucket Policy documentation.

SMS event data can be asynchronous. All events are timestamped with the time they occurred, but they may not be available until a later time. This may happen when a user performs a task in your app but then loses connectivity. The event will be logged and included in your stream when the user regains connectivity. Asynchronous data will include events which happened within the past 48 hours of the stream transferring the data. Any event older than 48 hours will not be included.

SMS Campaign send

Target Location:

s3://[bucket_name]/sms_campaign_send/dt=[dt]/client_id=[id]/[filename].csv

Field Name

Data Type

Example

Description

client_id

int

3386

The client identifier. If the client has multiple accounts, this will be the child account which can be linked to the parent account through the account_id field.

profile_id

string

597fa1d224c17c309b02400

Unique identifier for the user profile.

message_id

string

5db2165b9c625f28504758d3

Unique identifier for the message. 

campaign_id

int

15273725

Unique identifier for the campaign send. All messages sent as part of the campaign on a particular date will share the same campaign_id.

sms

string

  

The profile’s sms number

sms_md5 

string

  

Hash of the profile’s sms number

from_sms

string

  

The sms displayed as the sender

send_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

event_id

string

018da7fe-4803-7d10-a547-68f0fb16af82

A uuid7 string that represents a unique event.

event_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

email_md5

string

81a1ffc0947e2ca9efadd006c10685ca

MD5 hash of the recipient's email address.

email_sha256

string

fbc1acf72184b83374e1920a6ee754e030e3c45defd2ce1ac75146c95f491bf3

SHA-256 hash of the recipient's email address.

email

string

  

The profile’s email address

extID

string

id_21529

A unique, user-specified identifier for a user's profile.

SMS Campaign bounce

Target Location:

s3://[bucket_name]/sms_campaign_bounce/dt=[dt]/client_id=[id]/[filename].csv

Field Name

Data Type

Example

Description

client_id

int

3386

The client identifier. If the client has multiple accounts, this will be the child account which can be linked to the parent account through the account_id field.

profile_id

string

597fa1d224c17c309b02400

Unique identifier for the user profile.

message_id

string

5db2165b9c625f28504758d3

Unique identifier for the message. 

campaign_id

int

15273725

Unique identifier for the campaign send. All messages sent as part of the campaign on a particular date will share the same campaign_id.

sms

string

  

The profile’s sms number

sms_md5 

string

  

Hash of the profile’s sms number

from_sms

string

  

The sms displayed as the sender

send_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

event_id

string

018da7fe-4803-7d10-a547-68f0fb16af82

A uuid7 string that represents a unique event.

event_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

email_md5

string

81a1ffc0947e2ca9efadd006c10685ca

MD5 hash of the recipient's email address.

email_sha256

string

fbc1acf72184b83374e1920a6ee754e030e3c45defd2ce1ac75146c95f491bf3

SHA-256 hash of the recipient's email address.

email

string

  

The profile’s email address

extID

string

id_21529

A unique, user-specified identifier for a user's profile.

SMS Campaign click

Target Location:
s3://[bucket_name]/sms_campaign_click/dt=[dt]/client_id=[id]/[filename].csv

Field Name

Data Type

Example

Description

client_id

int

3386

The client identifier. If the client has multiple accounts, this will be the child account which can be linked to the parent account through the account_id field.

profile_id

string

597fa1d224c17c309b02400

Unique identifier for the user profile.

message_id

string

5db2165b9c625f28504758d3

Unique identifier for the message. 

campaign_id

int

15273725

Unique identifier for the campaign send. All messages sent as part of the campaign on a particular date will share the same campaign_id.

sms

string

  

The profile’s sms number

sms_md5 

string

  

Hash of the profile’s sms number

from_sms

string

  

The sms displayed as the sender

send_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

event_id

string

018da7fe-4803-7d10-a547-68f0fb16af82

A uuid7 string that represents a unique event.

event_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

url

string

ttps://www..com/marketing-blog/luxury-brands-embracing-ecommerce/

The url of the clicked link.

ip

string

127.255.255.255

Can be either an IPv4 or IPv6 address. The value provided is the address that would log at the edge of our network, as seen when an event comes into our platform for processing.

ip_type

string

IPv4

Specifies the IP address type observed.

browser

string

iPhone

Device/browser used by the recipient.

useragent

string

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/93.0.4577.82 Safari/537.36

The value noted is the user agent string data as seen when an event comes into our platform, without any transformation.

email_md5

string

81a1ffc0947e2ca9efadd006c10685ca

MD5 hash of the recipient's email address.

email_sha256

string

fbc1acf72184b83374e1920a6ee754e030e3c45defd2ce1ac75146c95f491bf3

SHA-256 hash of the recipient's email address.

email

string

  

The profile’s email address

extID

string

id_21529

A unique, user-specified identifier for a user's profile.

SMS Triggered send

Target Location:
s3://[bucket_name]/sms_triggered_send/dt=[dt]/client_id=[id]/[filename].csv

Field Name

Data Type

Example

Description

client_id

int

3386

The client identifier. If the client has multiple accounts, this will be the child account which can be linked to the parent account through the account_id field.

profile_id

string

597fa1d224c17c309b02400

Unique identifier for the user profile.

message_id

string

5db2165b9c625f28504758d3

Unique identifier for the message. 

sms

string

  

The profile’s sms number

sms_md5 

string

  

Hash of the profile’s sms number

from_sms

string

  

The sms displayed as the sender

is_basic

boolean

  

True if the template is a transaction template

send_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

flow_id

string

79c15585-ee58-4ca2-8f3f-7ec4d1a2d831

Unique identifier for the LO flow that triggered this send. Foreign key to the lifecycle_optimizer_flow lookup data.

event_id

string

018da7fe-4803-7d10-a547-68f0fb16af82

A uuid7 string that represents a unique event.

event_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

email_md5

string

81a1ffc0947e2ca9efadd006c10685ca

MD5 hash of the recipient's email address.

email_sha256

string

fbc1acf72184b83374e1920a6ee754e030e3c45defd2ce1ac75146c95f491bf3

SHA-256 hash of the recipient's email address.

email

string

  

The profile’s email address

extID

string

id_21529

A unique, user-specified identifier for a user's profile.

SMS Triggered bounce

Target Location:
s3://[bucket_name]/sms_triggered_bounce/dt=[dt]/client_id=[id]/[filename].csv

Field Name

Data Type

Example

Description

client_id

int

3386

The client identifier. If the client has multiple accounts, this will be the child account which can be linked to the parent account through the account_id field.

profile_id

string

597fa1d224c17c309b02400

Unique identifier for the user profile.

message_id

string

5db2165b9c625f28504758d3

Unique identifier for the message. 

sms

string

  

The profile’s sms number

sms_md5 

string

  

Hash of the profile’s sms number

from_sms

string

  

The sms displayed as the sender

is_basic

boolean

  

True if the template is a transaction template

send_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

flow_id

string

79c15585-ee58-4ca2-8f3f-7ec4d1a2d831

Unique identifier for the LO flow that triggered this send. Foreign key to the lifecycle_optimizer_flow lookup data.

event_id

string

018da7fe-4803-7d10-a547-68f0fb16af82

A uuid7 string that represents a unique event.

event_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

email_md5

string

81a1ffc0947e2ca9efadd006c10685ca

MD5 hash of the recipient's email address.

email_sha256

string

fbc1acf72184b83374e1920a6ee754e030e3c45defd2ce1ac75146c95f491bf3

SHA-256 hash of the recipient's email address.

email

string

  

The profile’s email address

extID

string

id_21529

A unique, user-specified identifier for a user's profile.

SMS Triggered click

Target Location:
s3://[bucket_name]/sms_triggered_click/dt=[dt]/client_id=[id]/[filename].csv

Field Name

Data Type

Example

Description

client_id

int

3386

The client identifier. If the client has multiple accounts, this will be the child account which can be linked to the parent account through the account_id field.

profile_id

string

597fa1d224c17c309b02400

Unique identifier for the user profile.

message_id

string

5db2165b9c625f28504758d3

Unique identifier for the message. 

sms

string

  

The profile’s sms number

sms_md5 

string

  

Hash of the profile’s sms number

from_sms

string

  

The sms displayed as the sender

is_basic

boolean

  

True if the template is a transaction template

send_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

flow_id

string

79c15585-ee58-4ca2-8f3f-7ec4d1a2d831

Unique identifier for the LO flow that triggered this send. Foreign key to the lifecycle_optimizer_flow lookup data.

event_id

string

018da7fe-4803-7d10-a547-68f0fb16af82

A uuid7 string that represents a unique event.

event_time

timestamp

2024-02-14T21:42:15.520123Z

A timestamp string with microsecond level precision (YYYY-MM-DD HH:MM:SS.SSSSSS) The time is in UTC.

url

string

ttps://www..com/marketing-blog/luxury-brands-embracing-ecommerce/

The url of the clicked link.

ip

string

127.255.255.255

Can be either an IPv4 or IPv6 address. The value provided is the address that would log at the edge of our network, as seen when an event comes into our platform for processing.

ip_type

string

IPv4

Specifies the IP address type observed.

browser

string

iPhone

Device/browser used by the recipient.

useragent

string

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/93.0.4577.82 Safari/537.36

The value noted is the user agent string data as seen when an event comes into our platform, without any transformation.

email_md5

string

81a1ffc0947e2ca9efadd006c10685ca

MD5 hash of the recipient's email  address.

email_sha256

string

fbc1acf72184b83374e1920a6ee754e030e3c45defd2ce1ac75146c95f491bf3

SHA-256 hash of the recipient's email address.

email

string

  

The profile’s email address

extID

string

id_21529

A unique, user-specified identifier for a user's profile.