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 {clientName}
and {date}
as variable values. For example, file names for the General Events data feed follow the format {clientName}_attentive_email_SMS_{date}.csv
, and file names for the Conversions data feed follow the format {clientName}_attentive_conversions_{date}.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.
Important: 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:
Event | Type | Definition |
Subscriber | JOIN | The event recorded when a user completes the double opt-in process (reply Y) or sends the pre-filled join message for Two-Tap to become an active SMS subscriber. This is a sign up-based event. |
CLICK | The event recorded when a user submits their phone number and clicks the submission button through the Attentive sign-up unit. This is a sign up-based event. | |
IMPRESSION | The event recorded when the Attentive creative displays on your website. This is a sign up-based event. | |
EMAIL_SAVE | The event recorded when a user submits their email through the Attentive creative (only applicable for Email and SMS sign-up units). This is a sign up-based event. | |
OPT_OUT | The event recorded when a user is unsubscribed from SMS. | |
CUSTOM_ATTRIBUTES | 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. | |
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 subscribers to your Attentive program. | Message | MESSAGE_RECEIPT | The event recorded when an active SMS subscriber receives an SMS message sent from you through the Attentive platform. This is a message-based event. |
MESSAGE_LINK_CLICK | The event recorded when an active email or SMS subscriber clicks the Attentive shortlink within a message. This is a message-based event. | |
EMAIL_MESSAGE_OPENED | The event recorded when an active email subscriber opens an email message sent from you through the Attentive platform. This is a message-based event. | |
EMAIL_SPAM_REPORTED | The event recorded when an email message sent from you through the Attentive platform is reported as spam. This is a message-based event. | |
EMAIL_DROPPED | The event recorded when an email message sent from you through the Attentive platform is dropped. This is a message-based event. | |
EMAIL_PROCESSED | The event recorded when an email message sent from you through the Attentive platform is processed. This is a message-based event. | |
EMAIL_BLOCKED | The event recorded when an email message sent from you through the Attentive platform is blocked. This is a message-based event. | |
EMAIL_DEFERRED | The event recorded when an email message sent from you through the Attentive platform is deferred. This is a message-based event. | |
EMAIL_HARD_BOUNCE | The event recorded when an email message sent from you through the Attentive platform results in a hard bounce. This is a message-based event. | |
EMAIL_SOFT_BOUNCE | The event recorded when an email message sent from you through the Attentive platform results in a soft bounce. This is a message-based event. | |
EMAIL_DELIVERED | The event recorded when an active email subscriber is delivered an email message sent from you through the Attentive platform. This is a message-based event. | |
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 address, among other things. Once this event occurs, we suppress messages to the email address in question unless they’re manually unsuppressed. | |
SUBSCRIPTION_OPT_IN_STARTED | The event recorded for the first part of a double opt-in, before the potential subscriber sends a Reply Y. | |
SUBSCRIPTION_UNSUPPRESSED | The event recorded when a SUBSCRIPTION_SUPPRESSED is manually reversed. |
Based on the included event types from the above list, the following headers are included in the data file.
Header | Events | Type | Length | Description |
type | All types | string | 25 | The event type from the above list |
phone | All types | string | 25 | The E.164 formatted phone number. |
client_id | All types | string | 100 | The user_id collected from the client's website. This is not an Attentive user ID.
For example: |
All types | string | 50 | The format validated email address. | |
timestamp | All types | string | 50 | The time (in UTC) at which a given event Type (i.e., a row) occurred.
For example: |
join_source | Subscriber type | string | 25 | See the Data field definitions article to view descriptions of each available value. |
subscription_type | Subscriber type | string | 25 | See the Data field definitions article to view descriptions of each available value. |
subscription_channel | Subscriber type | string | 25 | Indicates the event is associated to either their EMAIL or TEXT subscription. |
message_id | Message type | int | The internal unique identifier for the message.
For example: |
|
message_name | Message type | string | 255 | The name of the text message a subscriber received through Attentive.
For example: |
message_text | Message type | string | 2048 | The body from the UI. |
message_type | Message type | string | 32 | The automated message type. See the Data field definitions article to view descriptions of each available value. |
message_subtype | Message type | string | 32 | The automated message subtype. See the Data field definitions article to view descriptions of each available value. |
message_start | Message type | int | The date and time the message started to send.
For example: |
|
message_link_target | Message type | string | 2048 | The destination of a link in a message. |
campaign_name | Message type | string | 255 | The name of the campaign associated with a message, if it was part of a campaign. |
campaign_type | Message type | string | 255 | Campaigns can be sent instantly (type INSTANT) or delayed (SUBSCRIBER_OPTIMIZED_SEND_TIME, SUBSCRIBER_LOCAL_TIME). |
creative_id | Subscriber type | int | 10 | The internal unique identifier for the sign-up unit hosted by Attentive.
For example: |
creative_name | Subscriber type | string | 255 | The internal name of the Attentive sign-up unit from which a given user subscribed.
For example: |
creative_type | Subscriber type | string | 255 | The automated creative type. See the Data field definitions article to view descriptions of each available value. |
creative_subtype | Subscriber type | string | 255 | The automated creative subtype. See the Data field definitions article to view descriptions of each available value. |
property_id | Custom attribute type | int | 10 | The Attentive-assigned identifier for a single property_name.
For example: |
property_name | Custom attribute type | string | 65535 | The client-defined name of the attribute assigned to the subscriber.
For example: |
property_value_id | Custom attribute type | int | 10 | The Attentive-assigned ID for each pre-defined attribute value. If the attribute type is "Custom Input," then this column will be blank.
For example: |
property_value | Custom attribute type | string | 65535 | The value of the attribute selected by or assigned to the subscriber.
For example: |
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 | Type | Length | Description |
phone | string | 25 | The E.164 formatted phone number. |
client_id | string | 100 | The user_id collected from the client's website. This is not an Attentive user ID.
For example: |
amount | decimal | 9, 2 | The purchase amount. |
timestamp | string | 50 | The time (in UTC) at which a given event Type (i.e., a row) occurred.
For example: |
message_id | int | n/a | The internal unique identifier for the message.
For example: |
message_name | string | 255 | The name of the text message a subscriber received through Attentive.
For example: |
message_text | string | 2048 | The body from the UI. |
message_type | string | 32 | The automated message type. See the Data field definitions article to view descriptions of each available value. |
message_subtype | string | 32 | The automated message subtype. See the Data field definitions article to view descriptions of each available value. |