Attentive SFTP data feeds
Attentive provides two different types of data feeds that are updated daily: General Events and Conversions. These data feeds are available on a nightly basis after 01:00 UTC in an assigned SFTP folder. The file names are configurable using {attn_domain}, {file_type}, and {date_str} as variable values. For example, file names for the General Events data feed and Conversions data feed follow the format {attn_domain}_attentive_{file_type}_{date_str}.csv. The outcome would look something like: whatevercompany_attentive_email_SMS_20230131.csv.
Tip: Contact our White Glove team (whiteglove@attentivemobile.com) or your dedicated Client Strategy Manager (CSM) if you'd like an example data feed file for more information.
Note: For compliance purposes, we purge all files after 30 days. After that point, you're no longer able to view or download them.
See the following sections to learn more about each data feed that Attentive can provide.
General Events Data Feed
This file contains events generated from Attentive. The following event types are available:
| Type | Definition |
|---|---|
| SUBSCRIPTION_OPT_IN_COMPLETED | The event recorded when a user completes the double opt-in process (reply Y) to become an active SMS subscriber or when a user submits their email through an Attentive sign-up unit (only applicable for email and SMS sign-up units). This is a sign up-based event. |
| SUBSCRIPTION_OPTED_OUT | The event recorded when a user unsubscribes from SMS. This event accounts for both SMS and EMAIL subscriptions, and used to be called OPT_OUT. |
| IMPRESSION | The event recorded when the Attentive creative is displayed on your website. This is a sign up-based event. |
| CLICK | The event recorded when a user submits their phone number and clicks Submit through the Attentive sign-up unit. This is a sign up-based event. |
| MESSAGE_RECEIPT | The event recorded when an active SMS subscriber receives an SMS message from Attentive. This is a message-based event. |
| MESSAGE_LINK_CLICK | The event recorded when an active subscriber clicks the Attentive shortlink within an message. This is a message-based event. To differentiate between SMS and EMAIL messages, a subscription\_channel column can be added. |
| CLOSE | The event recorded when an Attentive creative is closed by a user. |
| USER_PROPERTY_SET | The event recorded when an attribute or preference is assigned to a subscriber. These attributes may be collected via the Custom Attributes API, via Attentive sign-up units, or within journeys. |
| PRODUCT_VIEW | The event recorded when the Attentive tag or eCommerce API tracks a product view for a user. These events are collected for all users on your site, not just active Attentive subscribers. |
| ADD_TO_CART | The event recorded when the Attentive tag or eCommerce API tracks an add to cart action for a user. These events are collected for all users on your site, not just active Attentive subscribers. |
| PURCHASE | The event recorded when the Attentive tag or eCommerce API tracks a purchase for a user. These events are collected for all users on your site, not just active Attentive subscribers. |
| SUBSCRIBER_TAG | The event recorded when a tag is applied to a subscriber as part of segmentation. |
| SUBSCRIPTION_OPT_IN_STARTED | The event recorded for the first part of a double opt-in, before the potential subscriber replies 'Y'. |
| SUBSCRIPTION_ALREADY_SUBSCRIBED | This event is recorded when a user attempts to sign up, but they were already registered as a subscriber. This will trigger even if their subscriber record is inactive. |
| EMAIL_DELIVERY_EVENTS | These events are recorded whenever there's an email status update. This event type will include the following sub-events, differentiated within the type column:EMAIL_DROPPED: Our email send service won't attempt to send the email, for example if the email contains spam content or the recipient is on an unsubscribe list. EMAIL_PROCESSED: Our email send service received the request to send the email, but hasn't yet decided to send the email. EMAIL_BLOCKED: Our email send service tried to deliver an email, but the receiving server couldn't or wouldn't accept the message temporarily. EMAIL_DEFERRED: Our email send service tried to deliver an email, but the email inbox client temporarily rejected it. EMAIL_BOUNCE: Our email send service tried to deliver an email, but the receiving server couldn't or wouldn't accept mail to this recipient permanently. EMAIL_DELIVERED: Our email send service successfully landed the email in the recipient's inbox. |
| EMAIL_MESSAGE_OPENED | The event recorded when an active email subscriber opens an email sent. |
| EMAIL_SPAM_REPORTED | The event recorded when an active email subscriber reports an email as spam. |
| SUBSCRIPTION_SUPPRESSED | An email-specific event that occurs automatically when an email bounces. It may be caused by the sender being blocked, an incorrectly formatted email, or an inactive email, among other things. Once this event occurs, we suppress messages to the email address in question unless they're manually unsuppressed. |
| SUBSCRIPTION_UNSUPPRESSED | The event recorded when a SUBSCRIPTION\_SUPPRESSED is manually reversed. |
Data Feed Field Breakdown
The table below outlines every field we support across all event types.
| Header | Relevant Events | Description |
|---|---|---|
| type | All types | The event type from the above list |
| status | All types | Whether the subscriber is active |
| phone | All types | The E.164 formatted phone number. |
| phone_country | All types | Country of origin for a phone number |
| client_id | All types | The user_id collected from the client's website. This is not an Attentive user ID. For example: 1234567890 |
| All types | The format validated email address. | |
| zipcode | All types | Additional location info |
| date | All types | Auto-formatted timestamp |
| timestamp | All types | The time (in UTC) at which a given event Type (i.e., a row) occurred. For example: 2020-04-10T21:55:00+00:00 |
| join_source | All events with SUBSCRIBER_ prefix | See Event data field definitions to view descriptions of each available value. |
| subscription_type | All events with SUBSCRIBER_ prefix | See Event data field definitions to view descriptions of each available value. |
| subscription_channel | All subscriber related events | A type of action that occurred, usually through one of two channels, text or email. Example: a customer subscribing, a message being sent. |
| visitor_id | All types | tag-generated visitor_id |
| uuid | All types | An encoded event ID |
| total | PURCHASE, CONVERSIONS | Total price for the purchase |
| source | All events with SUBSCRIBER_ prefix | How the event was generated, either DIRECT from a text, DOUBLE_OPT_IN, or CODE. |
| external_id | All types | A version of subscriber ID that can be shared externally with clients. |
| raw_external_id | All types | external_id is a hashed version of the ID often used by webhooks. This value is the unhashed version, which is useful if you want to match with a webhook event. |
| order_id | PURCHASE, CONVERSIONS | ID associated with a transaction |
| quantity | PURCHASE, ADD_TO_CART, CONVERSIONS | The number of products in a transaction |
| coupons | All types | The coupons associated with a subscriber |
| product_name | PURCHASE, ADD_TO_CART, PRODUCT_VIEW | The name of the product in question |
| product_sku | PURCHASE, ADD_TO_CART, PRODUCT_VIEW | The SKU for the product in question |
| product_price | PURCHASE, ADD_TO_CART, PRODUCT_VIEW | The price of the product in question |
| product_id | PURCHASE, ADD_TO_CART, PRODUCT_VIEW | ID can be distinct from SKU if there are multiple variants of a certain product |
| sub_product_id | PURCHASE, ADD_TO_CART, PRODUCT_VIEW | The variant_id of a product |
| message_id | MESSAGE_RECEIPT, MESSAGE_LINK_CLICK | The internal unique identifier for the message. Example: 123456 |
| message_name | MESSAGE_RECEIPT, MESSAGE_LINK_CLICK | The name of the text message a subscriber received through Attentive. Example: Free Shipping Extended |
| message_text | MESSAGE_RECEIPT, MESSAGE_LINK_CLICK | The body from the UI. |
| message_type | MESSAGE_RECEIPT, MESSAGE_LINK_CLICK | The automated message type. See Event data field definitions to view descriptions of each available value. |
| message_subtype | MESSAGE_RECEIPT, MESSAGE_LINK_CLICK | The automated message subtype. See Event data field definitions to view descriptions of each available value. |
| message_start | MESSAGE_RECEIPT, MESSAGE_LINK_CLICK | The date and time the message started to send. Example: 12/8/20 16:45 |
| creative_id | All events with SUBSCRIBER_ prefix | The internal unique identifier for the sign-up unit hosted by Attentive. Example: 12345 |
| creative_name | All events with SUBSCRIBER_ prefix | The internal name of the Attentive sign-up unit from which a given user subscribed. Example: Email+SMS Mobile Fullscreen |
| creative_type | All events with SUBSCRIBER_ prefix | The automated creative type. See Event data field definitions to view descriptions of each available value. |
| creative_subtype | All events with SUBSCRIBER_ prefix | The automated creative subtype. See Event data field definitions to view descriptions of each available value. |
| property_id | USER_PROPERTY_SET | The Attentive-assigned identifier for a single property_name. Example: 1234 |
| property_name | USER_PROPERTY_SET | The client-defined name of the attribute assigned to the subscriber. Example: First Name |
| property_value_id | USER_PROPERTY_SET | The Attentive-assigned ID for each pre-defined attribute value. If the attribute type is "Custom Input," then this column will be blank. Example: 4567 |
| property_value | USER_PROPERTY_SET | The value of the attribute selected by or assigned to the subscriber. Example: Jane |
| message_link_target | MESSAGE_RECEIPT, MESSAGE_LINK_CLICK | The destination of a link in a message |
| campaign_name | MESSAGE_RECEIPT, MESSAGE_LINK_CLICK, all EMAIL events | The name of the campaign associated with a message, if it was part of a campaign. |
| campaign_type | MESSAGE_RECEIPT, MESSAGE_LINK_CLICK, all EMAIL events | Campaigns can be sent instantly (type INSTANT) or delayed (SUBSCRIBER_OPTIMIZED_SEND_TIME, SUBSCRIBER_LOCAL_TIME) |
Conversions Data Feed
This file contains conversions data, which is calculated based on the behavioral data collection. Each message field shows the message associated with the conversion data.
| Header | Description |
|---|---|
| phone | The E.164 formatted phone number. |
| The formatted email address | |
| external_id | Encoded format of a subscribers external ID. |
| client_id | The user_id collected from the client's website. This is not an Attentive user ID. Example: 1234567890 |
| amount | The purchase amount. |
| uuid | An encoded event ID. |
| timestamp | The time (in UTC) at which a given event Type (i.e., a row) occurred. Example: 2021-03-30T00:09:07 |
| message_id | The internal unique identifier for the message. Example: 123456 |
| message_name | The name of the text message a subscriber received through Attentive. Example: Free Shipping Extended |
| message_text | The body from the UI. |
| message_type | The automated message type. See Event data field definitions to view descriptions of each available value. |
| message_subtype | The automated message subtype. See Event data field definitions to view descriptions of each available value. |
| order_id | The conversions purchase ID taken from the client's site at time of purchase. |
| product_skus | A list of product skus. |
| coupon | Any coupons used for the transaction. |
| quantity | The number of products in a transaction. |