Understanding the Format of the CRM Feed from the Platform

The CRM feed is designed as a mechanism by which referral data can be exported and sent to you in a format suitable for putting into a CRM system. For example, you can track customer behaviour, such as who referred new customers, new potential customers (opted in but yet to purchase), and how many times referrers have shared and referred successfully.

We can send you the CRM feed daily or weekly for you to put into your CRM system.

It contains a row per customer. Customers appear in the file if they’ve been referred in the period (normally past 7 days) or have shared or successfully referred anyone in the period (normally past 7 days).

We recommend using this feed as follows:

Update the data of records with an email or customer id you’ve seen before. For records with new emails, add to your system as new customers (although they should also be in your CRM by the time they’re in this feed).

As a simple reference file format, this is what the columns do and how they're formatted:

Each rows describes: whether they were referred (by who, and when signed up, when rewarded) and whether they have referred anyone else (share count, successful referrer count)

Specifically the feed contains:

CustomerFirstname - The firstname of the customer - VARCHAR 255 - Nullable CustomerSurname - The surname of the customer - VARCHAR 255 - Nullable 
CustomerEmail - The email address of the customer - VARCHAR 255 - Not Nullable MerchantCustomerID - Your reference to identify this customer (if we have been passed it) - VARCHAR 255 - Nullable 
CustomerRecognisedDate - date which we first became aware this was a customer of yours - DATE_TIME - Not Nullable 
ReferredByCustomerEmail - if they were referred, who this customer was referred by - VARCHAR 255 - Nullable 
ReferredByMerchantCustomerID - if they were referred, who this customer was referred by (your ID) - VARCHAR 255 - Nullable 
OptedInToReceivedMerchantMarketingEmail - whether during the course of being referred, they have left the opt-in ticked saying they are happy to receive your communications - BOOLEAN (1/0) ReferredDate - the date on which their introduction as a Referee occurred (normally the date of clicking on a share link or entering their name) - DATE_TIME - Nullable 
ReferredSituation - the situation (channel) via which the referrer registered - VARCHAR 255 - Nullable 
ReferredShareType - the share type via which the referrer was made eg FACEBOOK - VARCHAR 255 - Nullable 
ReferredSegment - segment via which the referral was made eg VIP - VARCHAR 255 - Nullable 
ReferredSignedUpDate - the date on which they "signed up" (or purchased) on the Merchant site (when we received the order tag - DATE_TIME - Nullable 
ReferredRewardedDate - the date we issued them a coupon or reward (incentive to purchase or reward for purchasing) - DATE_TIME - Nullable 
ReferredQualifiedDate - the date they were "qualified as a new customer" - DATE_TIME - Nullable IsReferrer - whether this customer is a referrer (has engaged with the referral programme) - doesn't mean they have necessarily shared - BOOLEAN (1/0) ReferrerSegments - the comma separated list of "segment" values of the referrer when they registered - List of VARCHAR 255 - Nullable 
ReferringShareCount - the number of shares the referrer has made - Integer - Nullable ReferringSuccessfulReferralsCount - the number of successful referrals the referrer

What's included in this report?

Here are a couple of rows of sample data to show the column headings and example values.