Purchase Referral Attribution
*For Storefront Developers Only
You may be interested in analyzing the referral sources to your storefront for purchases. This information is included alongside Purchase information, if it is available.
(recommended) Add utm_source
to links to your webshop
utm_source
to links to your webshopEnsure any direct links to your storefront URL have this referral parameter appended.
Some social media sites, like Facebook, automatically append click ID's to their URLs to allow attribution to work. Others, like Discord, do not always do this. If you want to track referrals consistently, we recommend append theutm_source
param to all of your respective URLs accordingly:
www.exampleshop.com/?utm_source=discord
Accepted utm_source
values typically follow lowercase and no-space formatting: facebook
, discord
, instagram
, twitter
, youtube
, google
, chatgpt
, support
Ingest the purchase data via webhook or API
To read the referral
object on the Purchase, you can ingest the purchase.completed
webhook or call the Purchase API (e.g. GET /
purchases ) to read information about the referral source in the referral
object.
referral.source
is derived from a combination of UTM parameters, click IDs, and HTTP headers sent in the initial request. referral.method
describes which method was used for deriving the referral.source
.
Updated about 14 hours ago