10/13/21

Labels and IP/UA data in Sailthru Connect!

We are proud to announce an enhancement to our Sailthru Connect suite of data products: we’re now offering Labels data and IP and User Agent string data in Event Stream!

A Note about Forward Compatibility

Sailthru will continue to iterate on its Event Stream offering, in an additive manner (sometimes referred to as “forward compatibility”. New fields that appear in the file outputs will not necessarily match older schemas, and will generally be forward compatible.

As part of this and future feature releases, Sailthru advises that customer teams refer to a field by column name, and not by position. We recommend that customers avoid expecting or validating against a fixed number of fields, which would cause errors if additional columns are provided. Sailthru will look to give advance warning in the case of any changes, and will work to minimize breaking changes to the schema at any time (i.e. field name changes, field removals).

What to expect about the Labels data in Event Stream

The relevant schema subset for Labels data includes:

  • campaign (ADDITION)
  • template (ADDITION)
  • label (NEW)
Table Name Campaign
Table Type  Lookup
Target Location s3://[bucket_name]/campaign/dt=[dt]/hr=[hr]/client_id=[id]/[filename].csv
Field Name Data Type Example Description
See existing Getstarted Documentation
label_ids array “[5d1640fb6feb44bdb50c72bc, 5d83ab476feb44bdb55fda0d, 5d88e22f6feb44bdb57399fe]” The unique identifier(s) which tie a Campaign to a Label. Note that Sailthru allows a user in the my.sailthru UI to associate a Label directly to a Campaign. This is independent of the Template-to-Label association.

 

Table Name Template
Table Type Lookup
Target Location s3://[bucket_name]/template/dt=[dt]/hr=[hr]/client_id=[id]/[filename].csv
Field Name Data Type Example Description
See existing Getstarted Documentation
label_ids array “[5cdc25636feb44bdb5e1b949, 5d83ab476feb44bdb55fda0e, 5ea1b364f68d5e34b4cd5e38]” The unique identifier(s) which associate a Sailthru Template to a Label. Note that Sailthru allows a user in the my.sailthru UI to associate a Label directly to a Template. This is independent of the Campaign-to-Label association.

 

Table Name Label
Table Type  Lookup
Target Location s3://[bucket_name]/label/dt=[dt]/hr=[hr]/client_id=[id]/[filename].csv
Field Name Data Type Example Description
client_id int 3386 Sailthru client identifier. Foreign key to the Client lookup table. If the client has multiple Sailthru accounts, this will be the child account which can be linked to the parent account through the lookup table.
label_id UUID 60c21795a1a5332aff168c2f The unique identifier for a label. Can be used to join either from the Campaign lookup table or Template lookup table for the corresponding “name” value.
name string BRAND X NL The value of the Label that is displayed in the my.sailthru UI.

 

What to expect about the IP and UA data in Event Stream

The relevant schema subset for IP and User Agent string data includes:

  • campaign_open
  • campaign_click
  • triggered_open
  • triggered_click

 

Example of schema additions

Table Name Campaign Open
Table Type  Event
Target Location s3://[bucket_name]/campaign_open/dt=[dt]/hr=[hr]/client_id=[id]/[filename].csv
Field Name Data Type Example Description
See existing Getstarted Documentation
ip string 127.255.255.255 Can be either an IPv4 or IPv6 address. The value provided is the address that Sailthru 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.
user_agent 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.

For brevity, note that Campaign Click, Triggered Open, and Triggered Click have the same fields added to the schema.

Top