You are here:
Create a Chat Messaging Data Extract in Marketing Cloud Engagement
Use Automation Studio and Contact Builder to create Chat Messaging Data Extracts and learn more about your message metrics.
- In Automation Studio, click New Automation.
- Drag the Data Extract activity to the Automation canvas.
- Click Choose.
-
Click Create New Data Extract and create a data extract file.
-
Select ChatMessagingDetailExtract.
If you’re using wildcards in your file name, only use trailing ones. For example, test_mo_log_%%Year%%%%Month%%%%Day%%.zip.
- Channel ID: The phone number for your WhatsApp channel. Use the country code and phone number with no symbols.
- Channel Type: WHATSAPP.
- Include MOLog: Provides a raw data file with inbound messages from customers.
- Include Tracking Detail: Provides detail disposition for Sends and the corresponding Inbound Tracking. If you choose to not include tracking details, some delivery receipts aren’t included if they’re near the end of the set sending time period. If you use a rolling range, you get a complete dataset.
- Include Potential Bounces: WhatsApp doesn’t provide unsubscribe information. If a user hasn’t received a message three times in the last 30 days, they’re counted as bounced users. It’s possible bounced users opted out and blocked the brand’s WhatsApp channel.
-
Select ChatMessagingDetailExtract.
-
Create a File Transfer activity. Use the same file-naming pattern as the Data Extract
activity.
When you run the data extract, the file is stored in a Salesforce Safehouse. The file transfer activity moves the file to a configure file location.
-
Retrieve
your files from the SFTP server.

- Tracking file name: chat_{filename}_tracking.csv
- Inbound messages file name: chat_{filename}_inboundmessagelogs.csv
- Potential unsubscribes file name: chat_{filename}_potentialunsubs.csv
- Example log file name with date: chat_test_mo_log%%Year%%%%Month%%%%Day%%_tracking.csv
-
Import your information into a data extract.
- In Contact Builder, create a data extension.
- In Contact Builder, create an import definition.
| Name | Description | Data Type |
|---|---|---|
| TrackingType | Send disposition in Marketing Cloud Engagement. Is either DeliveryReport or SEND | string |
| SendType | How the send was initiated: through Journey Builder or Transactional API or as a default response. | string |
| MID | Member ID for the sender | bigint |
| EID | Enterprise ID number for the sender | bigint |
| ContactKey | Contact key of the receiver | string |
| MobileNumber | Phone number of receiver | string |
| EventDateUTC | UTC date and time of the event | datetime |
| AppID | Application ID of the provider | string |
| ChannelID | Phone number of the registered channel | string |
| ChannelType | Channel platform (WhatsApp) | string |
| ConversationType | Meta-defined conversation category with one of these values: Marketing, Utility, Authentication, Service, Referral. ConversationType is assigned only for sent or delivered messages that have a TrackingType value of DeliveryReport. | string |
| ActivityName | Name of message activity related to the send for the journey (WhatsApp) | string |
| ChannelName | Name of channel used | string |
| Status | Send status provided by sender or Marketing Cloud Engagement | string |
| Reason | If Status is negative, this field provides further details | string |
| JBDefinitionID | Unique identifier for the journey a message was deployed from | unique identifier |
| SendIdentifier | Internal Engagement identifier for a send. This identifier associates a unique SEND”with the corresponding “DeliveryReport” information. Order or date can’t be verified when sending to the same contact many times. This field is your source of truth for data association of send and delivery reports. |
unique identifier |
| AssetID | Asset ID associated with the Send. Available on Send type only. | bigint |
| MessageTypeID | Internal send type ID | int |
| JBActivityID | Unique identifier for the message within the journey | unique identifier |
| Name | Description | Data Type |
|---|---|---|
| ChatMessagingMOLogID | Unique database identifier in sequential order | bigint |
| ChannelID | Phone number of the registered channel | string |
| ChannelType | Channel platform (WhatsApp) | string |
| MobileNumber | Phone number of contact who responded to the channel | string |
| MessageData | JSON-formatted data from our partner. The Text field displays inbound text. | string |
| DateCreatedUTC | UTC date and time the inbound message was received in Engagement | datetime |
| Name | Description | Data Type |
|---|---|---|
| MID | Member ID for the sender | bigint |
| EID | Enterprise ID number for the sender | bigint |
| ContactKey | Contact key of the receiver | string |
| MobileNumber | Phone number of receiver | string |
| ChannelID | Phone number of the registered channel | string |
| ChannelType | Channel platform (WhatsApp) | string |
| ChannelName | Name of channel provided by customer | string |
| FirstDateUTC | UTC date and time of first send without delivery tracking | datetime |
| LastDateUTC | UTC date and time of last send without delivery tracking | datetime |
A user is marked as a potential unsubscribe if:
- At least three messages have failed to send to the user
- There are no successful sends to the user during the report’s selected time window
A message is defined as failed to send if it has a Failed status or a Not Sent status with Reason 100.

