Acoustic
Overview
Acoustic (previously known as Silverpop) is a marketing platform that enables email, SMS, and mobile campaigns, among other marketing analytics and automation solutions.
Integrating Lytics with Acoustic allows you to import users and their activity data to build behavioral audiences and gain Insights in Lytics. You can then export Lytics audiences back to Acoustic to refine your targeting and deliver personalized messaging.
Authorization
If you have not done so already, you will need to set up an Acoustic account before you begin the process described below. Your Acoustic account user must have permission to create Application Access via the API.
- Select Acoustic from the list of providers.
- Select the Full Auth method for authorization.
- Enter a Label to identify your authorization.
- (Optional) Enter a Description for further context on your authorization.
- Enter your Client ID for the application that you have created in your Acoustic account. For more information, please refer to Acoustic Documentation.
- Enter the Client Secret for your entered Client ID.
- Enter the Pod number of your Acoustic Campaign. You can find the Pod information in Account Setting page of your Acoustic account. For example, if it is Pod 2 then just enter 2.
- Enter Refresh Token that you have created to grant Lytics access. For more information, please refer to Acoustic Documentation.
- Enter your SFTP Username for the Acoustic Account.
- Enter your SFTP Password for the above SFTP User. You can use your own credentials here, or create a new user for this integration.
- Click Save Authorization.
For this integration, it is recommended to create a new Acoustic User specific for Lytics with the option
Do not enforce password expiration policies for this user
selected so the authentication is long lasting, and can be revoked on an account by account basis.
Import Audiences & Activity
Import Acoustic users and their activity information into Lytics so you can leverage that data to build behavioral audiences and gain Insights powered by Lytics data science.
Integration Details
- Implementation Type: Server-side Integration.
- Implementation Technique: XML API Integration to download CSV formatted data.
- Frequency: Data is imported as a Batch Integration; imported once, or every 8 hours on a continuous basis.
- Resulting Data: Full Lytics user profiles for all Acoustic users complete with activity data.
This integration utilizes the Acoustic XML API to import Acoustic users and their activity to Lytics. Each run of the job will proceed as follows:
- Exports users from the selected Acoustic Database as a CSV file to an Acoustic-manged SFTP server. The CSV files are then read and imported to the
silverpop_users
stream in Lytics. - Exports email activity from users in the selected Acoustic Database as a CSV file to an Acoustic-manged SFTP server. The CSV files are then read and imported to the
silverpop_activity
stream in Lytics. - After successful completion, the job will import new/updated users with their updated activity every 8 hours if configured to run continuously.
Fields
The following fields are included in the default mapping for the silverpop_users
stream. Note this integration was formerly named Silverpop, hence the data stream name, but this job will receive your current Acoustic data.
Source Field | Lytics User Field | Description | Type |
---|---|---|---|
email unique_id | Email Address | string | |
First Name | first_name | First Name | string |
Last Name | last_name | Last Name | string |
Email Type | sp_email_type | Acoustic Email Type | string |
map(list, Opted Out ) | sp_list_optout_status | Acoustic Optout Status by List | map[string]string |
map(list, todate(Opted Out Date )) | sp_list_opt_out_date | Acoustic Opt Out Date by List | map[string]time |
map(list, todate(Opt In Date )) | sp_list_opt_in_date | Acoustic Opt In Date by List | map[string]time |
map(list, Opt In Details ) | sp_list_opt_in_details | Acoustic Opt In Details | map[string]string |
emaildomain(email) | emaildomain | Email Domain | string |
Similarly, the following fields are included in the default mapping for the silverpop_activity
stream:
Source Field | Lytics User Field | Description | Type |
---|---|---|---|
email unique id | string | ||
emaildomain | Email Domain | string | |
Url | hashedurls | Hashed Urls Visited | map[string]intsum |
max(epochms()) | last_active_ts | Last Active on Any Channel | date |
Campaign Id | sv_campaign_ids | Acoustic Campaign the send originated from | []string |
event | sv_clickct | Acoustic Click count | int |
Event Type | sv_email_event | Acoustic Events | map[string]intsum |
Url | sv_email_urls | Acoustic URLs | []string |
min(epochms()) | sv_firstclick_ts | Acoustic First Click | date |
min(epochms()) | sv_firstopen_ts | Acoustic First Open | date |
min(epochms()) | sv_firstsent_ts | Acoustic First Sent | number |
hourofday() | sv_hourlyopen | Acoustic Hourly Events | map[string]intsum |
hourofweek() | sv_hourofweek | Acoustic Hour of Week Events | map[string]intsum |
max(epochms()) | sv_lastclick_ts | Acoustic Last Click | date |
max(epochms()) | sv_lastopen_ts | Acoustic Last Open | date |
max(epochms()) | sv_lastsent_ts | Acoustic Last Sent | date |
list_id | sv_list_ids | Acoustic List the send originated from | []string |
Mailing Id | sv_mailing_ids | Acoustic Mailing the send originated from | []string |
Mailing Name | sv_mailing_names | Acoustic Mailing Names | []string |
Mailing Name | sv_mailing_names_click_count | Acoustic Mailing Names Click Count | map[string]intsum |
Mailing Name | sv_mailing_names_clicked | Acoustic Mailing Names Clicked | []string |
Mailing Name | sv_mailing_names_open_count | Acoustic Mailing Names Open Count | map[string]intsum |
Mailing Name | sv_mailing_names_opened | Acoustic Mailing Names Opened | []string |
Mailing Name | sv_mailing_names_sent | Acoustic Mailing Names Sent | []string |
Mailing Name | sv_mailing_names_sent_count | Acoustic Mailing Name Sent Count | map[string]intsum |
yymm() | sv_monthly | Acoustic Opens By Month | map[string]intsum |
event | sv_openct | Acoustic Open count | int |
Program Id | sv_program_ids | Acoustic Program Ids | []string |
min(epochms()) | sv_subscribe_ts | Acoustic Subscribe Time | date |
min(epochms()) | sv_unsubscribe_ts | Acoustic Unsubscribe Time | date |
Configuration
Follow these steps to set up an Import Audiences and Activity Data job for Acoustic.
- Select Acoustic from the list of providers.
- Select the Import Audiences and Activity Data job type from the list.
- Select the Authorization you would like to use or create a new one.
- Enter a Label to identify this job you are creating in Lytics.
- (Optional) Enter a Description for further context on your job.
- From the Type dropdown, select the Acoustic source type: database, list, or query.
- From the Source dropdown, select the Acoustic source to import user data from.
- Click on the Show Advanced Options tab to expand the advanced configuration.
- Check the Keep Updated checkbox to update the list every 8 hours.
- In the Activity Start field, enter the date to import activity from. The default is to retrieve one year of activity.
- Click Start Import.
Export Audiences
Send Lytics user profiles and audience membership to your Acoustic Database to refine your targeting and deliver personalized messaging across channels. All existing users and new users of the selected Lytics audiences are exported.
Integration Details
- Implementation Type: Server-side Integration.
- Implementation Technique: API Integration , Audience Trigger Integration .
- Frequency: Real-time Integration.
- Resulting data: Lytics users are exported to Acoustic Database.
This integration utilizes the Acoustic Import List API to export user data from Lytics to the Acoustic Database. Once the export is started, the job:
- Creates the column mapping file according to the fields selected during configuration and uploads to the Acoustic Campaign SFTP server.
- Writes the users that are part of selected Lytics audiences to the CSV file and initiates the CSV Import job in Acoustic.
- Repeats step 1 and 2 every 15 minutes if job is configured to update continuously.
Fields
You can export any Lytics user fields to Acoustic Database columns that are present in the selected Acoustic Database. Lytics allows you to map user fields with the corresponding Acoustic Database columns as part of the job configuration described below.
To export using the Acoustic Recipient ID as the sync field use the Acoustic Export Audience with Recipient ID export.
Configuration
Follow these steps to set up an Export Audiences job for Acoustic.
- Select Acoustic from the list of providers.
- Select the Export Audiences job type from the list.
- Select the Authorization you would like to use or create a new one create a new one.
- Enter a Label to identify this job you are creating in Lytics.
- (Optional) Enter a Description for further context on your job.
- From the Acoustic Database dropdown, select the Acoustic database to populate with Lytics users.
- Using the Audience list, select the Lytics audiences to export. As users enter or exit the selected audience(s) their record will be sent to Acoustic.
- From the Sync Fields mapping, choose the sync fields that are used to match and identify users like unique ID or email. At least one sync field must be specified.
- From the Additional Map Fields, map additional fields that you would like to send from Lytics to Acoustic by selecting the Lytics field on the left, and its Acoustic destination on the right.
- From Fields to Trigger, select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user will be updated in Acoustic.
- Check the Create New Contacts checkbox to create new contacts in Acoustic if they do not already exist.
- Check the Update Contacts checkbox to update fields of existing contacts in Acoustic.
- In the Single Audience Field text field, select a field or enter a name to create a field to write the additional Lytics audiences to. If the field is left empty, a Yes/No field is created for each selected Lytics audience.
- (Optional) In the Single Audience File Empty String text field, specify this to a value like "null" to represent an empty audience. Otherwise, an empty string is sent by default.
- Check the Keep Updated checkbox to continuously export users as they enter the audience.
- From the Time of Day dropdown, select a time of day to complete export each day. Export will sync every hour if left empty.
- From the Timezone dropdown, select the timezone for time of day specified above.
- Click Start Export.
Export Audiences with Recipient ID
Send Lytics user profiles and audience membership to your Acoustic Database to refine your targeting and deliver personalized messaging across channels. All existing users and new users of the selected Lytics audiences are exported.
This export is specifically used for exporting using the Acoustic Recipient ID as the sync field. It will only update users already in Acoustic with a Recipient ID. In order to add users to Acoustic or if you would like to use other sync fields use the standard Acoustic Export Audience export.
Integration Details
- Implementation Type: Server-side Integration.
- Implementation Technique: API Integration , Audience Trigger Integration .
- Frequency: Real-time Integration.
- Resulting data: Lytics users are exported to Acoustic Database.
This integration utilizes the Acoustic Import List API to export user data from Lytics to the Acoustic Database. Once the export is started, the job:
- Creates the column mapping file according to the fields selected during configuration and uploads to the Acoustic Campaign SFTP server.
- Writes the users that are part of selected Lytics audiences to the CSV file and initiates the CSV Import job in Acoustic.
- Repeats step 1 and 2 every 15 minutes if job is configured to update continuously.
Fields
You can export any Lytics user fields to Acoustic Database columns that are present in the selected Acoustic Database. Lytics allows you to map user fields with the corresponding Acoustic Database columns as part of the job configuration described below.
Configuration
Follow these steps to set up an Export Audiences job for Acoustic.
- Select Acoustic from the list of providers.
- Select the Export Audiences job type from the list.
- Select the Authorization you would like to use or create a new one.
- Enter a Label to identify this job you are creating in Lytics.
- (Optional) Enter a Description for further context on your job.
- From the Acoustic Database dropdown, select the Acoustic database to populate with Lytics users.
- Using the Audience list, select the Lytics audiences to export. As users enter or exit the selected audience(s) their record will be sent to Acoustic.
- From the Recipient ID field, choose the field that contains the Acoustic Recipient ID in Lytics.
- From the Additional Map Fields, map additional fields that you would like to send from Lytics to Acoustic by selecting the Lytics field on the left, and its Acoustic destination on the right.
- From Fields to Trigger, select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user will be updated in Acoustic.
- In the Single Audience Field text field, select a field or enter a name to create a field to write the additional Lytics audiences to. If the field is left empty, a Yes/No field is created for each selected Lytics audience.
- (Optional) In the Single Audience File Empty String text field, specify this to a value like "null" to represent an empty audience. Otherwise, an empty string is sent by default.
- Check the Keep Updated checkbox to continuously export users as they enter the audience.
- From the Time of Day dropdown, select a time of day to complete export each day. Export will sync every hour if left empty.
- From the Timezone dropdown, select the timezone for time of day specified above.
- Click Start Export.
Export Audiences to Table
Send Lytics user profile data and audience membership to your Acoustic Relational tables. All existing and new users of the selected audience are exported in real-time.
Integration Details
- Implementation Type: Server-side Integration.
- Implementation Technique: API Integration , Audience Trigger Integration .
- Frequency: Real-time Integration.
- Resulting data: Lytics users are exported to Acoustic Relational Table.
This integration utilizes the Acoustic Relational Table Management api to export user data from Lytics to the Acoustic Relational Table. Once the export is started, the job:
- Creates an user table and an audience table or uses the one provided during configuration. It also creates table for every non-scalar field selected for the export.
- For every user entering/existing the audience, it will add/update the row in the user table.
- Writes audience membership as
true
orfalse
for each exported audience in separate column in the audience table. - Writes any selected Lytics non-scalar field data to its own table.
- Sends the update to Acoustic every 5 minutes or when the queue has 1000 users.
- Repeats step 2 to 5.
Fields
You can export any Lytics user fields to Acoustic Relational Table. Lytics allows you to map user fields with the corresponding table columns as part of job configuration. The job also has option to create column in Acoustic table for Lytics user field.
Configuration
Follow these steps to set up an Export Audiences job for Acoustic.
- Select Acoustic from the list of providers.
- Select the Export Audience to Acoustic Relational Table job type from the list.
- Select the Authorization you would like to use or create a new one.
- Enter a Label to identify this job you are creating in Lytics.
- (Optional) Enter a Description for further context on your job.
- Using the Audiences list, select the Lytics audiences to export. As users enter or exit the selected audience(s) their record will be sent to Acoustic.
- From the Acoustic User Table dropdown, select the Acoustic relational table to populate with user profile data. Select
Create New Table
to create new user table with namelytics_user_table_{timestamp}
.{timestamp}
is replaced with current timestamp in formatYYYYMMDDHHmmss
. - From the User Table Key Field dropdown, select the Lytics user field to be used as primary key for new user table. This is required field for new table, not required if existing Acoustic table is selected.
- From the Acoustic User Table Mapping, map Lytics user fields that you would like to send from Lytics to Acoustic by selecting the Lytics field on the left, and its Acoustic relational table column on the right. NOTE: All the key column for the selected Acoustic user table must be mapped. This is required field if existing Acoustic table is used.
- Using the Extra Fields list, select the Lytics user fields to export. These are extra fields to be sent to Acoustic table. Each field will be added as a separate column in the table.
- From the Acoustic Audience Membership Table dropdown, select the Acoustic relational table to populate with audience information. Select
Create New Table
to create new audience table with namelytics_audiences_table_{timestamp}
.{timestamp}
is replaced with current timestamp in formatYYYYMMDDHHmmss
. NOTE: A YES/NO column will be created for each audience selected for export. For user that belongs to the audience will havetrue
as value in the respective audience column. Similarly,false
if user does not belong to the audience. - From the Audience Membership Table Key Field dropdown, select the Lytics user field to be used as primary key for new audience membership table. This is required field for new table, not required if existing Acoustic table is selected.
- From the Acoustic Audience Membership Table Key Mapping, map Lytics user fields with Acoustic audience membership key column. Primary key must be mapped. This is not required if
Create New Table
is selected. - Using the Non-Scalar User Fields list, select any Lytics non-scalar user field to export. Acoustic relational table with name
lytics_{field-name}_table_{timestamp}
will be created for each selected non-scalar field. - From the Non-Scalar Field Table Key Field dropdown, select Lytics user field to be used as primary key for all new non-scalar field table.
- Select Existing Users to send existing users to Acoustic.
- Click Start Export.
Updated 4 months ago