Conversion tracking require a Business plan subscription or higher.
When it comes to conversion tracking, a lead event 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
A diagram showing how lead events are tracked in the conversion funnel
In this guide, we will be focusing on tracking new user sign-ups for a SaaS application that uses Appwrite for user authentication.

​
Prerequisites

Before you get started, make sure you follow the CodeQR Conversions quickstart guide to get CodeQR Conversions set up for your links:
  1. Enable conversion tracking for your links
  2. Install the @codeqr/analytics client-side SDK
  3. Install the CodeQR server-side SDK

​
Configure Appwrite

Next, configure Appwrite to track lead conversion events during the sign up process.
1

Create an Appwrite Cloud project

Head to Appwrite Cloud and create a new project.
New project on Appwrite Cloud
Create a new API key with the sessions.write scope enabled and save the API key for later use. You can also copy your project ID and endpoint from the project’s Settings page.
API key in your project on Appwrite Cloud
Then, in your Next.js app, install the Appwrite Node.js SDK.
npm i node-appwrite
2

Add environment variables

Add the following environment variables to your app.
NEXT_PUBLIC_APPWRITE_ENDPOINT=https://cloud.appwrite.io/v1
NEXT_PUBLIC_APPWRITE_PROJECT=<APPWRITE_PROJECT_ID>
NEXT_APPWRITE_KEY=<APPWRITE_API_KEY>
NEXT_CODEQR_API_KEY=<CODEQR_API_KEY>
3

Integrate CodeQR Analytics

Add the CodeQRAnalytics component from the @codeqr/analytics package to your app’s root layout.
src/app/layout.tsx
import type { Metadata } from 'next';
import { Analytics as CodeQRAnalytics } from '@codeqr/analytics/react';

export const metadata: Metadata = {
  title: 'Appwrite CodeQR Leads Example',
  description: 'Appwrite CodeQR Leads Tracking example app with Next.js'
};

export default function RootLayout({
  children
}: Readonly<{
  children: React.ReactNode;
}>) {
  return (
    <html lang="en">
      <body>{children}</body>
      <CodeQRAnalytics />
    </html>
  );
}
4

Prepare the Appwrite client and auth library

Create the Appwrite Session and Admin client (necessary for SSR apps, as explained in the Appwrite docs). Additionally, create a function to verify user login.
src/lib/server/appwrite.ts
'use server';
import { Client, Account } from 'node-appwrite';
import { cookies } from 'next/headers';

export async function createSessionClient() {
  const client = new Client()
    .setEndpoint(process.env.NEXT_PUBLIC_APPWRITE_ENDPOINT as string)
    .setProject(process.env.NEXT_PUBLIC_APPWRITE_PROJECT as string);

  const session = (await cookies()).get('my-custom-session');
  if (!session || !session.value) {
    throw new Error('No session');
  }

  client.setSession(session.value);

  return {
    get account() {
      return new Account(client);
    }
  };
}

export async function createAdminClient() {
  const client = new Client()
    .setEndpoint(process.env.NEXT_PUBLIC_APPWRITE_ENDPOINT as string)
    .setProject(process.env.NEXT_PUBLIC_APPWRITE_PROJECT as string)
    .setKey(process.env.NEXT_APPWRITE_KEY as string);

  return {
    get account() {
      return new Account(client);
    }
  };
}
5

Set up CodeQR SDK

Create the CodeQR client and send leads to CodeQR using the codeqr.track.lead() function.
src/lib/server/codeqr.ts
import type { Models } from 'node-appwrite';
import { CodeQR } from 'codeqr';

const codeqr = new CodeQR({
  apiKey: process.env.NEXT_CODEQR_API_KEY
});

export function addCodeQRLead(user: Models.User<Models.Preferences>, cq_id: string) {
  codeqr.track.lead({
    clickId: cq_id,
    eventName: 'Sign Up',
    externalId: user.$id,
    customerName: user.name,
    customerEmail: user.email
  });
}
6

Send leads to CodeQR on user signup

In the /auth page, use the Appwrite Admin client to allow users to sign up. Post sign up, check if the cq_id cookie is present, send a lead event to CodeQR if found, and delete the cq_id cookie.
src/app/auth/page.tsx
import { ID } from 'node-appwrite';
import { createAdminClient, getLoggedInUser } from '@/lib/server/appwrite';
import { cookies } from 'next/headers';
import { redirect } from 'next/navigation';
import { addCodeQRLead } from '@/lib/server/codeqr';

async function signUpWithEmail(formData: any) {
  'use server';

  // Get sign up info from form
  const email = formData.get('email');
  const password = formData.get('password');
  const name = formData.get('name');

  // Create account and session using Appwrite
  const { account } = await createAdminClient();

  const user = await account.create(ID.unique(), email, password, name);
  const session = await account.createEmailPasswordSession(email, password);

  (await cookies()).set('my-custom-session', session.secret, {
    path: '/',
    httpOnly: true,
    sameSite: 'strict',
    secure: true
  });

  // Check if CodeQR ID is present in cookies and track lead if found
  const cq_id = (await cookies()).get('cq_id')?.value;
  if (cq_id) {
    addCodeQRLead(user, cq_id);
    (await cookies()).delete('cq_id');
  }

  // Redirect to success page
  redirect('/auth/success');
}

export default async function SignUpPage() {

  // Verify active user session and redirect to success page if found
  const user = await getLoggedInUser();
  if (user) redirect('/auth/success');

  return (
    <>
      <form action={signUpWithEmail}>
        <input id="email" name="email" placeholder="Email" type="email" required />
        <input id="password" name="password" placeholder="Password" minLength={8} type="password" required />
        <input id="name" name="name" placeholder="Name" type="text" required />
        <button type="submit">Sign up</button>
      </form>
    </>
  );
}
Here’s the full list of attributes you can pass when sending a lead event:
PropertyRequiredDescription
clickIdYesThe unique cq_id parameter that the lead conversion event is attributed to.
eventNameYesThe name of the event. Example: “Sign up”.
externalIdYesThe unique ID of the customer in your system. Will be used to identify and attribute all future events to this customer.
customerEmailNoThe email address of the customer. If not passed, a random email address will be generated.
customerNameNoThe name of the customer. If not passed, a random name will be generated (e.g. “Big Red Caribou”).
customerAvatarNoThe avatar URL of the customer. If not passed, a random avatar URL will be generated.

​
Example App

To learn more about how to track leads with Appwrite, check out the following example app:

Appwrite + CodeQR Next.js Example

See how to track new user sign-ups with Appwrite and the CodeQR SDK.

​
View your conversions

Once you’ve enabled conversion tracking for your links, all your tracked conversions will show up on your Analytics dashboard. We provide 3 different views to help you understand your conversions:
Time-series line chart
  • Funnel chart: A funnel chart view visualizing the conversion & dropoff rates across the different steps in the conversion funnel (clicks → leads → sales).
Funnel chart view showing the conversion & dropoff rates from clicks → leads → sales
  • Real-time events stream: A real-time events stream of every single conversion event that occurs across all your links in your workspace.
The Events Stream dashboard on CodeQR