Last updated
These docs are intended for a developer audience.Dismiss

Lead source attribution

This topic describes lead source attribution and how to use it in Rebilly.

Lead source attribution is the process of tracking and linking marketing campaigns to new customers who make purchases as a result of those campaigns. This metadata is added to the customer's information, and contains common attributes from Google Analytics and affiliate tracking applications.

Rebilly records the following lead source information:

  • Original lead source: Entity that introduces the customer to your application.
  • Intermediary lead sources: Entities that influence the customer to use or return to your application.
  • Most recent lead source: The last entity which interacts with the customer before they complete a payment in your application.

Lead source attribution can be used with the Rebilly Instruments and FramePay JavaScript libraries. It is also available through the Rebilly API.

Attribution

Rebilly automatically captures lead source attributes from the payment form web address when a payment completes, and stores this data in the customer record.

By default, lead source attribution is active in Rebilly Instruments and FramePay. To deactivate lead source attribution in Rebilly Instruments, see Features configuration properties. To deactivate lead source attribution in FramePay, see Define lead source data.

UTM parameters

Use these UTM parameters to track marketing campaigns:

UTM Parameter ExampleLead source parameter
utm_sourceutm_source=Googlesource
utm_mediumutm_medium=cpcmedium
utm_campaignutm_campaign=facebookcampaign
utm_termutm_term=red+shirtterm
utm_contentutm_content=bannerlinkcontent

Additional parameters

You can also use these additional tracking parameters in the web address.

Lead source parameterExample
affiliateaffiliate=Acme
subAffiliatesubAffiliate=junior
clickIdclickId=btnSale
salesAgentsalesAgent=jdoe

Example

This example describes how Rebilly processes UTM parameters and additional tracking parameters:

https://www.example.com/checkout?utm_content=buynowlink&utm_medium=social&utm_source=facebook.com&utm_campaign=instantbuy&affiliate=gearbuy

Rebilly captures this lead source data from the URL:

{
    leadSource: {
        content: 'buynowlink',
        medium: 'social',
        source: 'facebook.com',
        campaign: 'instantbuy',
        affiliate: 'gearbuy'
    }
}

View lead source data

To view or edit a customer's lead source data, see View or edit customer lead source information.