Salesforce Marketing Cloud is a platform for delivering relevant, personalized journeys across channels and devices - enabling marketers to deliver the right message at the right time throughout all phases of the relationship. This API connector can be used to retrieve Email data from Email Studio, including device, browser, operating system, geolocation and domain breakdowns, and campaign details.
For more information about Marketing Cloud, click here.
The SFMC API pulls data from your Marketing Cloud instance via an S3 extract. If this is the first time Marketing Cloud Intelligence Data Pipelines is requesting this data extract for your Marketing Cloud instance, you can pull data for 180 days back.
- Channel: Email Marketing
- Data Stream Type: Messaging
- Data Lagging: 1 Day
Prerequisites
- To connect to the Salesforce Marketing Cloud API, you need a valid username and password with Email Studio and API access.
- The user must have Enterprise-level access.
- The user must also be an Admin and Marketing Cloud Admin.
- This API connector supports the following account type:
- Enterprise 1.0
- Enterprise 2.0
- Core or Connect
The user must have access to the parent member otherwise the authentication will fail.
- If you want to access Journey Builder, MobileConnect, and MobilePush data make sure you have API access to the relevant features as well. If you don’t have the required access information or encounter any issues, contact your Marketing Cloud representative.
When setting up your permissions for Marketing Cloud, under Datorama, select the Enable Datorama Integration checkbox.
General Setup
After entering your credentials, select the Enterprise and Members (also known as Business Units in Marketing Cloud) you want to retrieve data for. To retrieve the data for all Members, leave this field empty.
Extended Properties
- Time Zone - From the dropdown list, select the time zone you want to report daily data on. It’s highly recommended you set the same time zone that is used for Marketing Cloud Enterprise to avoid data discrepancies.
- Get Test Emails - Select this checkbox to retrieve test emails in addition to the existing data. To view the Dimensions and Measurements retrieved, see Email below.
- Get Journey Data - Select this checkbox to retrieve enriched Dimensions of Email and Mobile data in addition to the data retrieved by the API by default. To view the Dimensions and Measurements retrieved, see Journey below.
- Get MobileConnect Data - Select this checkbox to retrieve SMS data from MobileConnect, in addition to the Email data retrieved by the API by default. To view the Dimensions and Measurements retrieved, see MobileConnect below.
- Get MobilePush Data - Select this checkbox to retrieve push notification data from MobilePush, in addition to the Email data retrieved by the API by default. To view the Dimensions and Measurements retrieved, see MobilePush below.
Available Marketing Cloud Intelligence Data Pipelines Measurements and Dimensions
The following tables display the available Measurement and Dimensions that will be mapped depending on the checkboxes you select in Extended Properties. By default, Marketing Cloud Intelligence Data Pipelines automatically pulls Email data, if you want to also pull Journey Builder, MobileConnect, or MobilePush data, you must make sure you select the appropriate checkbox in Extended Properties (as described above).
| Source | type | mapping |
|---|---|---|
| Campaign End Date (Formula) | Dimension | Campaign End Date |
| Campaign Key | Dimension | Campaign Key |
| Campaign Name | Dimension | Campaign Name |
| Campaign Start Date (Formula) | Dimension | Campaign Start Date |
| Campaign Status | Dimension | Campaign Status |
| Country | Dimension | Country |
| Event Date | Dimension | Day |
| Email Delivered Time | Dimension | Message Send Date |
| Email Domain | Dimension | Recipient Domain |
| Email From Email | Dimension | Message Send Sender Email |
| Email From Name | Dimension | Message Send Sender |
| Email Job Id | Dimension | Message Send Key |
| Email Job Status | Dimension | Message Send Status |
| Email Job Type | Dimension | Message Send Type |
| Email Name | Dimension | Message Send Name |
| Email Pre Header | Dimension | Message Send Pre Header |
| Email Subject | Dimension | Message Send Subject |
| Enterprise Id | Dimension | Message Send Enterprise ID |
| Enterprise Name | Dimension | Message Send Enterprise |
| Member ID | Dimension | Message Send Advertiser ID |
| Member Name | Dimension | Message Send Advertiser |
| Message Type | Dimension | Message Send Subtype |
| Region | Dimension | Region |
| City | Dimension | Unmapped |
| Email Client | Dimension | Unmapped |
| Email Device | Dimension | Unmapped |
| Email Device Browser | Dimension | Unmapped |
| Email Operating System | Dimension | Unmapped |
| emailName | Dimension | Unmapped |
| Metro Code | Dimension | Unmapped |
| Email Bounces | Measurement | Message Bounces |
| Email Unique Clicks | Measurement | Message Total Clicks |
| Email Deliveries (Formula) | Measurement | Message Deliveries |
| Email Unique Opens | Measurement | Message Total Opens |
| Email Sends | Measurement | Message Sends |
| Email Unique Unsubscribes | Measurement | Message Total Unsubscribes |
Mobile Connect
The following Measurements and Dimensions are retrieved when connecting to your Marketing Cloud account:
The following Dimensions and Measurements are also retrieved when selecting the Get MobileConnect Data checkbox in Extended Properties:
| source | type | mapping |
|---|---|---|
| Campaign End Date | Dimension | Campaign End Date |
| Campaign Key | Dimension | Campaign Key |
| Campaign Name | Dimension | Campaign Name |
| Campaign Start Date | Dimension | Campaign Start Date |
| Campaign Status | Dimension | Campaign Status |
| Country | Dimension | Country |
| Date | Dimension | Day |
| Enterprise ID | Dimension | Message Send Enterprise ID |
| Enterprise Name | Dimension | Message Send Enterprise |
| Member ID | Dimension | Message Send Advertiser ID |
| Member Name | Dimension | Message Send Advertiser |
| Member Type | Dimension | Message Send Subtype |
| SMS Message ID | Dimension | Message Send Key |
| SMS Message Name | Dimension | Message Send Name |
| SMS Message Status | Dimension | Message Send Status |
| SMS Message Text | Dimension | Message Send Content |
| SMS Message Type | Dimension | Message Send Type |
| SMS Keyword | Dimension | Unmapped |
| SMS Origin | Dimension | Unmapped |
| SMS Short Code | Dimension | Unmapped |
| SMS Deliveries (Formula) | Measurement | Message Deliveries |
| SMS Undelivered | Measurement | Message Bounces |
| Inbounds | Measurement | Unmapped |
| SMS Outbound Responses | Measurement | Unmapped |
Journey
The following Dimensions are also be retrieved when selecting the Get Journey Data checkbox in Extended Properties:
| source | type | mapping |
|---|---|---|
| Journey Activity Name | Dimension | Journey Activity Name |
| Journey Activity Type | Dimension | Journey Activity Type |
| Journey ID + Journey Version | Dimension | Journey Key |
| Journey Name | Dimension | Journey Name |
| Journey Status | Dimension | Journey Status |
| Journey Version | Dimension | Journey Version |
| Contact Entry Mode | Dimension | Unmapped |
| Journey Created Date | Dimension | Unmapped |
| Journey Description | Dimension | Unmapped |
| Journey Last Published Date | Dimension | Unmapped |
| Journey Last Modified Date | Dimension | Unmapped |
MobilePush
The following Dimensions and Measurements will also be retrieved when selecting the Get MobilePush Data checkbox in Extended Properties:
| source | type | mapping |
|---|---|---|
| Campaign End Date | Dimension | Campaign End Date |
| Campaign Key | Dimension | Campaign Key |
| Campaign Name | Dimension | Campaign Name |
| Campaign Start Date | Dimension | Campaign Start Date |
| Campaign Status | Dimension | Campaign Status |
| Date | Dimension | Day |
| Member ID | Dimension | Message Send Advertiser ID |
| Member Name | Dimension | Message Send Advertiser |
| Push Message Content | Push Message Content | |
| Push Message Content Type | Dimension | Push Message Content Type |
| Enterprise ID | Dimension | Message Send Enterprise ID |
| Enterprise Name | Dimension | Message Send Enterprise |
| Push Message ID | Dimension | Message Send Key |
| Push Message Name | Dimension | Message Send Name |
| Push Message Status | Dimension | Message Send Status |
| Message Type | Dimension | Message Send Subtype |
| Push Message Type | Dimension | Message Send Type |
| Push Application Id | Dimension | Recipient Application Key |
| Push Device ID | Dimension | Unmapped |
| Push Device Name | Dimension | Unmapped |
| Push Device OS Version | Dimension | Unmapped |
| Push Device Type | Dimension | Unmapped |
| Push Geofence Name | Dimension | Unmapped |
| Push Message Subtitle | Dimension | Unmapped |
| Push Message Title | Dimension | Unmapped |
| Push Operating System | Dimension | Unmapped |
| Push Page URL | Dimension | Unmapped |
| Push Message Failures | Measurement | Message Failures |
| Push Sends | Measurement | Message Sends |
| Push Opens | Measurement | Message Total Opens |
| Push Opt-Ins | Measurement | Opt In |
| Push Opt-Outs | Measurement | Opt Out |
| Push Time in App | Measurement | Time in App |
| Push Time in App Open | Measurement | Unmapped |
Known Issues and Limitations
Email meta-data and engagement data, stored in the Marketing Cloud database is only accessible to third party apps, such as Marketing Cloud Intelligence Data Pipelines through daily extracts. Marketing Cloud, exports the data to an Amazon S3 bucket on a daily basis. The Marketing Cloud Intelligence Data Pipelines API then reads the data from the S3 bucket, aggregates it, and stores it on the Marketing Cloud Intelligence Data Pipelines data model.
The data in the S3 bucket is deleted after 90 days (to comply with the GDPR regulations) the deletion causes some of the limitations listed below:
- First Time Creating a Data Stream - The first time you create a Data Stream with your Enterprise account, a background provisioning process takes place enabling your Salesforce Marketing Cloud account to access this data. This process could take a couple of hours to complete and can cause the Data Stream to fail during initial data retrieval with a specific error - Initial Retrieval Timeout. You can either reprocess your data stream manually after a few hours, or it will reprocess and fix itself the next day.
- Send Date Dimension - The Send Date dimension for triggered (by journey or API) emails will not be available if more than 90 days have passed since the original send date. For example, if you send out an email for a specific campaign on January 1, 2021, and it was opened or clicked on April 1 2021, the send date dimension will not be available, so any engagement data from that email campaign will not have a send date since 90 days have passed since the original send date (January 1, 2021). Note: This limitation doesn’t affect standard emails.
- Campaigns Dimension - There are several limitations to the campaign dimension as
follows:
- Engagement data for campaigns created over 90 days ago won’t have the campaign information.
- In Marketing Cloud you can assign several campaigns, while in Marketing Cloud Intelligence Data Pipelines the data model only allows for one campaign, if you assigned several campaigns Marketing Cloud Intelligence Data Pipelines selects the first one.
- If the campaign code changes after the first time it’s set, Marketing Cloud Intelligence Data Pipelines won’t reflect those changes.
- Campaign data won’t populate if the campaign is assigned to the email after the email was sent.
- MobileConnect Message Definition - Messages can be created more than 90 days before the message is sent, in a case like this, the message information attached to the measurements won’t be available. For example, the message information attached to the measurement, such as Message Name won’t be available.
- Geolocation - The geolocation is derived from the IP address. Consumer rights (GDPR) can block the reporting of the IP address, making the data you have on geolocation incomplete. Another common issue with the accuracy of geolocations is the use of VPNs and Proxy Servers that cause the IP address to be unreliable and inaccurate in determining the geolocation.
- Content with Special Characters - When files contain special characters (non-ASCII) for example Spanish or Japanese, any data that contains multiple lines, could fail during parsing. When using non-English characters it’s recommended to check the Disable Multiple Parsing and Enable non-ASCII parsing checkbox. This checkbox parses non-English characters but can’t parse multiline, so it only pulls the first line of each field.
How to QA Your Data
For Intelligence Data Pipelines Reports for Engagement, complete the following steps:
- Go to the Marketing Cloud Report Builder.
- Navigate to: Analytics Builder > Marketing Cloud Intelligence Data Pipelines Reports > Pivot Tables
- Compare the totals of specific emails between Marketing Cloud Intelligence Data Pipelines and Intelligence Data Pipelines Reports for Engagement.
Marketing Cloud Configuration Best Practices
For an optimal view of your Marketing Cloud Intelligence Data Pipelines data, consider these best practices:
- Avoid special characters. Special characters and emoji in Marketing Cloud aren’t supported. They’re replaced with the replacement character
- Create a unique Campaign Code. The Campaign Code from Marketing Cloud will be mapped to Campaign Key in Marketing Cloud Intelligence Data Pipelines and the key must be unique to ensure proper data aggregation
- After a Campaign Code is set, don’t change it. Campaign Code in MC is a freeform field that can be manually changed after it is entered. If the Campaign Code changes after the time its first set, the change won’t be reflected.
- Assign the Campaign Key and Name prior to sending the email. Campaign data doesn’t populate if the campaign is assigned to the email after it was sent
- Assign only one campaign per message. The Marketing Cloud Intelligence Data Pipelines data model can only link one message to one Campaign Key.
- Because of the Campaign Name nuances, it’s best to leverage the Message Send Name for any naming convention.