> ## 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.

# Framer

> How to add @codeqr/analytics to your Framer site

With `@codeqr/analytics`, you can track lead and sale conversions on your Framer site, enabling you to measure the effectiveness of your marketing campaigns.

You can add the `@codeqr/analytics` script to your Framer website same way you would add Google Analytics script or any other JavaScript code.

Follow these steps to add the script to your site:

* Go to your Framer project and open the **Project Settings** menu.
* Open the **General** tab and scroll down to the **Custom Code** section.
* Paste the CodeQR analytics script in the **Start of head tag** section.
* Click on the **Save** button to save the changes.

```html theme={null}
<script src="https://cdn.codeqr.io/analytics/script.js" defer></script>
```

If you're using referral links for affiliate management, you will also need to set up the `data-domains` property to enable [client-side click-tracking](https://docs.codeqr.io/sdks/client-side/features/client-side-click-tracking.md).

```html theme={null}
<script
  src="https://cdn.codeqr.io/analytics/script.js"
  defer
  data-domains="{'refer':'yourcompany.link'}"
/>
```

Read the [client-side click-tracking guide](https://docs.codeqr.io/sdks/client-side/features/client-side-click-tracking.md) for more information.

> [!TIP]
>
> 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 `<head>` section of the page
> * If you're using a content delivery network (CDN), make sure to purge any cached content

## Concepts

You can pass the following props to the `@codeqr/analytics` script to customize its behavior:

**data-api-host** `url` (default: [https://api.codeqr.io](https://api.codeqr.io))

The base URL for the CodeQR API. This is useful for [setting up reverse
proxies](https://docs.codeqr.io/sdks/client-side/features/reverse-proxy-support.md) to avoid
adblockers.

**data-attribution-model** `first-click | last-click` (default: last-click)

The attribution model to use for the analytics event. The following
attribution models are available:

* `first-click`: The first click model
  gives all the credit to the first touchpoint in the customer journey.
* `last-click`: The last click model gives all the credit to the last
  touchpoint in the customer journey.

**data-cookie-options** `JSON-stringified object`

Custom properties to pass to the cookie. Refer to
[MDN's Set-Cookie documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) for
all available options.

**properties**

**domain** `string`

Specifies the value for the `Domain` Set-Cookie attribute. This is useful
for cross-domain tracking. Example: `.example.com`

**expires** `integer` (default: 90)

Specifies the `Date` object to be the value for the `Expires` Set-Cookie
attribute. Example: `new Date('2024-12-31')`

**expiresInDays** `integer` (default: 90)

Specifies the number (in days) to be the value for the `Expires`
Set-Cookie attribute.

For example, to set the cookie window to 60 days (instead of the default 90 days), you can add the following to your script:

```html theme={null}
<script
  src="https://cdn.codeqr.io/analytics/script.js"
  defer
  data-cookie-options='{"expiresInDays": 60}'
/>
```

**path** `string` (default: /)

Specifies the value for the `Path` Set-Cookie attribute. By default, the
path is considered the "default path". Example: `/`

**data-domains** `JSON-stringified object`

Configure the domains that CodeQR will track. The following properties are available:

**properties**

**refer** `string`

The CodeQR custom domain for [referral program client-side click tracking](http://d.to/clicks/refer) (previously `data-short-domain`).
Example: `refer.codeqr.io`

**site** `string`

The CodeQR short domain for tracking site visits.
Example: `site.codeqr.io`

**outbound** `string | string[]`

An array of domains for cross-domain tracking. When configured, the existing `cq_id` cookie
will be automatically appended to all outbound links targeting these domains to enable
cross-domain tracking across different applications.
Example: `"codeqr.link, git.new"`

**data-query-param** `string` (default: via)

The query parameter to listen to for client-side click-tracking (e.g.
`?via=abc123`).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.