> ## Documentation Index
> Fetch the complete documentation index at: https://docs.codeqr.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Quickstart
> Learn how to set up your referral/affiliate program with CodeQR Partners.
CodeQR Partners require a [Business plan](https://codeqr.io/pricing) subscription or
higher.
[CodeQR Partners](https://codeqr.io/help/article/codeqr-partners) lets you build powerful, scalable referral and affiliate programs with 1-click global payouts and white-labeling functionality.
In this guide, we'll walk you through the steps to get started with CodeQR Partners:
1. [Install the `@codeqr/analytics` client-side SDK](#step-1-install-the-codeqr-analytics-client-side-sdk)
2. [Install the CodeQR server-side SDK + track conversion events](#step-2-install-the-codeqr-server-side-sdk--track-conversion-events)
3. [Set up your partner program](#step-3-set-up-your-partner-program)
## Step 1: Install the `@codeqr/analytics` client-side SDK
First, you'll need to install the [@codeqr/analytics client-side SDK](/sdks/client-side/introduction).
This script detects the `cq_id` query parameter and storing it as a first-party cookie, which will be used to attribute subsequent conversion events to the original link.
On top of that, it also:
* lets you [track clicks on the client-side](/sdks/client-side/features/client-side-click-tracking) using query parameters (e.g. `?via=john`)
* [automatically fetch the partner and discount data](/sdks/client-side/features/client-side-click-tracking#automatically-fetching-partner-and-discount-data) for a given link – which is helpful for displaying [dual-sided incentives](https://codeqr.io/help/article/dual-sided-incentives)
You can install the `@codeqr/analytics` script in several different ways:
Add CodeQR Analytics to your React app
Add CodeQR Analytics to your website
}
href="https://docs.codeqr.io/sdks/client-side/installation-guides/framer"
>
Add CodeQR Analytics to your Framer site
Add CodeQR Analytics to your WP site
Add CodeQR Analytics to your Webflow site
You can **verify the installation** with the following tests:
1. Open the browser console and type in `_CodeQRAnalytics` – if the script is installed correctly, you should see the `_CodeQRAnalytics` object in the console.
2. Add the `?cq_id=test` query parameter to your website URL and make sure that the `cq_id` cookie is being set in your browser.
If both of these checks pass, the script is installed correctly. Otherwise, please make sure:
* The analytics script was added to the `` section of the page
* If you're using a content delivery network (CDN), make sure to purge any cached content
Once the script is installed, make sure to verify that [client-side click tracking](/sdks/client-side/features/client-side-click-tracking) is working as expected by checking if the following is true:
1. There is a successful `/track/click` request in your browser's **Network** tab (and no errors in the **Console** tab).
2. The `cq_id` cookie is being set upon a successful `/track/click` request.
3. The click tracked correctly in the [**Events**](https://app.codeqr.io/events) tab of your CodeQR project.
## Step 2: Install the CodeQR server-side SDK + track conversion events
If you are using Shopify, you can skip this step since our Shopify app will
automatically track conversions for you. Read the [Shopify integration
guide](https://docs.codeqr.io/conversions/sales/shopify) for more information.
CodeQR uses server-side event tracking to track conversions, which is more reliable than client-side tracking. Depending on which framework you're using, you can use our [native SDKs](/sdks/overview):
TypeScript library for the CodeQR API
If you're using a framework that isn't listed, you can use the CodeQR REST API to track events on the server-side:
* [`POST /track/lead`](https://docs.codeqr.io/api-reference/endpoint/track-lead)
* [`POST /track/sale`](https://docs.codeqr.io/api-reference/endpoint/track-sale)
Once you install the SDKs, you can start tracking conversion events.
### Tracking lead events
The first event you'll want to track is a `lead` event. This happens when a user performs an action that indicates interest in your product or service. This could be anything from:
* Signing up for an account
* Adding a product to cart
* Joining a mailing list
Our most common lead event is `Sign Up`, which happens when a user signs up for an account. Depending on which authentication framework you're using, here are a few examples of how to send `Sign Up` lead events:
The lead event will serve as the source of truth for the customer's identity and which link they came from. This means that all subsequent actions performed by the customer (e.g. upgrading their plan, purchasing a product) will automatically be attributed to the original link.
To learn more about tracking lead events with CodeQR, refer to the following resources:
Read the full guide on tracking lead events with CodeQR
View the full list of attributes you can pass when sending a lead event
### Tracking sale events
The second event you'll want to send is a `sale` event. This happens when a user purchases your product or service. This could be anything from:
* Subscribing to a paid plan
* Usage expansion (upgrading from one plan to another)
* Purchasing a product
Depending on which payment processor you're using, we offer native integrations for the following:
Alternatively, you can also send sale events manually using [our SDKs](/sdks/overview) or the [`POST /track/sale` API endpoint](https://docs.codeqr.io/api-reference/endpoint/track-sale).
To learn more about tracking sale events with CodeQR, refer to the following resources:
Read the full guide on tracking sale events with CodeQR
View the full list of attributes you can pass when sending a sale event
## Step 3: Set up your partner program
Once you have conversion tracking up and running, you can follow these steps to set up your partner program:
1. Go through the [program onboarding flow](https://app.codeqr.io/programs) to create your program.
* If you're migrating from another platform, you can also import your partners and historical conversions (e.g. [from Rewardful](https://codeqr.io/help/article/migrating-from-rewardful)).
2. [Connect your bank account](https://codeqr.io/help/article/how-to-set-up-bank-account) for partner payouts.
3. [Invite your partners](https://codeqr.io/help/article/inviting-partners) to join your program + set up your [program application form](https://codeqr.io/help/article/inviting-partners#via-a-branded-application-form) for future partners.
4. Create [custom reward rules](https://codeqr.io/help/article/partner-rewards) and [dual-sided incentives](https://codeqr.io/help/article/dual-sided-incentives) to incentivize partners to share your link with others.
5. Set up a [whitelabeled referral dashboard](/partners/white-labeling) that lives directly inside your app so your users can automatically enroll in your partner program without leaving your app.
