Overview
The CustomerOS website tracker allows you to monitor visitor behavior and identify users across your website. Once installed, it automatically tracks page views and custom events, providing valuable insights into how visitors interact with your site.Installation
To install the CustomerOS tracker, follow the instructions in the app with your specific reverse-proxied domain. Choose between the HTML script or JavaScript snippet depending on the application you are using.Identifying Users
Once the tracker script is loaded, you can identify users and attach custom properties to their profile using theidentify
function.
Basic Usage
When to Use Identify
Call theidentify
function at key moments in your user journey:
- After user login: Identify the user with their profile information
- After signup: Capture new user details
- On profile updates: Update user properties when they change
- On page load (for authenticated users): Ensure returning users are identified
Example: Identify on Login
Disabling Automatic Event Tracking
By default, the tracker automatically captures page views and events. If you want to disable automatic event tracking and only track events manually, set thec.__disableCosEvents__
parameter to true
.
This is especially helpful for preventing unwanted collection of data within applications where PII and other data may be sent and received.
Platform-Specific Guides
For specific implementation instructions for your platform, see the guides below:Webflow
Install on Webflow sites
Framer
Install on Framer sites
Mintlify
Install on Mintlify docs
Google Tag Manager
Install via Google Tag Manager
GitBook
Install on GitBook docs
Docusaurus
Install on Docusaurus sites
Fern
Install on Fern docs
Scalar
Install on Scalar API docs