> ## 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 track conversion analytics with CodeQR.
Conversion tracking require a [Business plan](https://codeqr.iopricing)
subscription or higher.
[CodeQR Conversions](https://codeqr.io/help/article/codeqr-conversions) is a powerful tool that lets you turn any [short link you create on CodeQR](https://codeqr.io/help/article/how-to-create-link) into a full attribution engine. This allows you to understand how well your links are translating to actual users and revenue dollars.
In this guide, we'll walk you through the steps to get started with CodeQR Conversions:
1. [Enable conversion tracking for your links](#step-1-enable-conversion-tracking-for-your-links)
2. [Install the `@codeqr/analytics` client-side SDK](#step-2-install-the-codeqr-analytics-client-side-sdk)
3. [Install the CodeQR server-side SDK + track conversion events](#step-3-install-the-codeqr-server-side-sdk-track-conversion-events)
4. [View your conversions](#step-4-view-your-conversions)
## Step 1: Enable conversion tracking for your links
First, you'll need to enable conversion tracking for your CodeQR links to be able to start tracking conversions.
There are a few ways to do this:
To enable conversion tracking for all future links in a project, you can do the following:
To enable conversion tracking for all future links in a project, you can do the following:
1. Navigate to your [project's Analytics settings page](https://app.codeqr.iosettings/analytics).
2. Toggle the **Project-level Conversion Tracking** switch to enable conversion tracking for the project.
This option will enable conversion tracking in the [CodeQR Link Builder](https://codeqr.io/help/article/codeqr-link-builder) for all future links.
If you don't want to enable conversion tracking for all your links in a project, you can also opt to enable it on a link-level.
To enable conversion tracking for a specific link, open the [CodeQR Link Builder](https://codeqr.io/help/article/codeqr-link-builder) for a link and toggle the **Conversion Tracking** switch.
You can also use the `C` keyboard shortcut when inside the link builder to
quickly enable conversion tracking for a given link.
Alternatively, you can also enable conversion tracking programmatically via the [CodeQR API](/api-reference/introduction). All you need to do is pass `trackConversion: true` when creating or updating a link:
```javascript Node.js theme={null}
const link = await codeqr.links.create({
url: "https://codeqr.io",
trackConversion: true,
});
```
## Step 2: Install the `@codeqr/analytics` client-side SDK
Next, 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.
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
## Step 3: 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 4: View your conversions
Once you've enabled conversion tracking for your links, all your tracked conversions will show up on your [Analytics dashboard](https://app.codeqr.ioanalytics). We provide 3 different views to help you understand your conversions:
* **Time-series**: A [time-series view](https://codeqr.io/help/article/codeqr-analytics#1-time-series-analytics-chart) of the number clicks, leads and sales.
* **Funnel chart**: A funnel chart view visualizing the conversion & dropoff rates across the different steps in the conversion funnel (clicks → leads → sales).
* **Real-time events stream**: A [real-time events stream](https://codeqr.io/help/article/real-time-events-stream) of every single conversion event that occurs across all your links in your project.
## Example Apps
See the full example on GitHub.