Documentation
Get Traceflow set up in minutes. Connect your email, add the tracking snippet to your website, and start seeing the complete customer journey — from first email to last page visit.
Getting Started
Set up Traceflow in under 5 minutes. You'll need a Traceflow account and access to your website's HTML.
Quick Setup (3 steps)
- 1Create your Traceflow account at app.gettraceflow.com
- 2Add the tracking snippet to your website (see next section)
- 3Connect your Gmail or Outlook account (see Email Integration)
What you'll see immediately
- Real-time visitor sessions on your website
- Page views and traffic sources
- Visitor locations and device types
- Real-time heatmap on every page
Install Tracking Snippet
Add one line of code to your website to capture the complete customer journey — every page, session, and interaction is tracked automatically.
The Tracking Script
Add this script tag inside the <head> or just before the closing </body> tag of every page on your website:
<script src="https://app.gettraceflow.com/tracer.js?uid=YOUR_UID&name=MyProject"></script>Replace YOUR_UID with your account ID and MyProject with your website/project name. Both are found in your Traceflow dashboard under Settings → Websites.
WordPress
Use the Insert Headers and Footers plugin, or add directly to your theme's header.php:
<?php wp_head(); ?>
<script src="https://app.gettraceflow.com/tracer.js?uid=YOUR_UID&name=MySite"></script>Shopify
Go to Online Store → Themes → Edit code → theme.liquid and add before </head>:
<script src="https://app.gettraceflow.com/tracer.js?uid=YOUR_UID&name=MyStore"></script>Next.js / React
Add to your _document.tsx or use Next.js Script component:
import Script from 'next/script';
<Script
src="https://app.gettraceflow.com/tracer.js?uid=YOUR_UID&name=MyApp"
strategy="afterInteractive"
/>Astro
Add to your base layout's <head> section:
<head>
<!-- other head tags -->
<script
is:inline
src="https://app.gettraceflow.com/tracer.js?uid=YOUR_UID&name=MySite"
></script>
</head>Email Integration
Connect your Gmail or Outlook account to unify email activity with website behavior into a single customer journey timeline.
Gmail Integration
- Go to Settings → Integrations in your Traceflow dashboard
- Click Connect Gmail
- Authorize Traceflow to access your Gmail account
- Traceflow will sync your email activity within minutes
Privacy: We only sync email metadata (to/from, subject, timestamps). We never read or store your email body content.
Outlook / Microsoft 365
- Go to Settings → Integrations in your Traceflow dashboard
- Click Connect Outlook
- Sign in with your Microsoft account and grant permissions
- Select the inbox(es) you want to sync
Note: Microsoft 365 Business accounts may require an admin to approve the Traceflow app in Azure AD.
What Gets Synced
Email events captured:
- Emails sent to a contact
- Email open events
- Link click events
- Reply received
Journey matching:
- Auto-matched by email address
- Linked to website sessions
- Combined into timeline
- Real-time updates
History imported:
- Up to 12 months of email history
- Imported on first connection
- Continuously synced after
Journey Timeline
The customer journey timeline is the core of Traceflow — a complete, chronological view of every interaction a customer has had with your business.
What appears in the timeline
- ● Email received, opened, or clicked
- ● Website visit started
- ● Pages visited (in order)
- ● Time spent per page
- ● Traffic source for each session
- ● Device and location per visit
- ● Return visits and re-engagement
- ● Engagement signal triggers
Finding a customer's timeline
- Go to Contacts in your Traceflow dashboard
- Search by email address, name, or company
- Click on a contact to open their full journey timeline
- Scroll through all email and web events in chronological order
Website Analytics
Full-stack website analytics for every site you configure — unique visitors, sessions, page views, traffic sources, locations, and device breakdowns.
| Metric | Description |
|---|---|
| Unique visitors | Distinct individuals who visited, identified by session or email |
| Sessions | Total browsing sessions (a session ends after 30 min of inactivity) |
| Page views | Total pages viewed, broken down by URL |
| Traffic sources | Email, organic search, social, direct, or referral |
| Locations | Country and city breakdown of your visitors |
| Devices | Mobile, desktop, and tablet breakdown |
All metrics automatically update in real time. No sampling — every visit is counted.
Real-time Heatmaps
See where customers click, scroll, and engage on every page of your website — in real time, with no separate configuration.
Heatmap types
- Click heatmap — Where users click on each page
- Scroll heatmap — How far down the page users scroll
- Move heatmap — Mouse movement patterns
Accessing heatmaps
- Go to Analytics → Heatmaps
- Select your website and the page URL
- Choose the date range and device type
- The heatmap overlay loads on a screenshot of your page
Note: Heatmaps are available on all plans. Resolution and historical retention vary by plan.
Multi-website Setup
Track customer journeys across multiple websites from a single Traceflow dashboard — ideal for agencies, SaaS products with marketing sites, or businesses with multiple brands.
Adding a website
- Go to Settings → Websites in your Traceflow dashboard
- Click Add Website
- Enter your website name and domain
- Copy the unique tracking script for this website — it includes your UID and the project name
- Add the script to your website (see Install Tracking Snippet)
- Data will appear in your dashboard within minutes of the first visitor
The number of websites you can add depends on your plan. See Pricing for details.
API & Webhooks
Use the Traceflow REST API to programmatically access journey data, or configure webhooks to receive real-time event notifications.
REST API
All API requests require your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
GET https://api.gettraceflow.com/v1/contacts
GET https://api.gettraceflow.com/v1/contacts/:email/journey
GET https://api.gettraceflow.com/v1/analytics/summaryFull API reference available in your dashboard under Developer → API Docs.
Webhooks
Get notified instantly when journey events occur. Configure webhook endpoints in Settings → Webhooks.
Available webhook events:
contact.visit— A known contact visits your sitecontact.email_opened— A contact opens your emailcontact.pricing_visited— A contact visits your pricing pagecontact.returned— A contact returns after >7 days inactive
GDPR Compliance
Traceflow is built with privacy-first principles. Here's how to use Traceflow in a GDPR-compliant way.
Your responsibilities as data controller
- ⚠ Disclose the use of Traceflow in your Privacy Policy
- ⚠ Obtain valid cookie consent before activating Traceflow tracking
- ⚠ Provide a mechanism for your users to request data deletion
- ⚠ Sign a Data Processing Agreement (DPA) with us if required by your legal team
Consent-first implementation
Load Traceflow only after consent is obtained by wrapping the script load in your CMP callback:
// Example: Load Traceflow only after user accepts analytics cookies
function loadTraceflow() {
const script = document.createElement('script');
script.src = 'https://app.gettraceflow.com/tracer.js?uid=YOUR_UID&name=MySite';
document.head.appendChild(script);
}
// Call this function when analytics consent is granted
window.onConsentGranted = loadTraceflow;Data deletion requests
When your end-users request data deletion, you can delete their data via the Traceflow dashboard or API:
DELETE https://api.gettraceflow.com/v1/contacts/:email
Authorization: Bearer YOUR_API_KEYThis permanently deletes all journey data, sessions, and email activity associated with that contact.
FAQ
Does Traceflow slow down my website?
No. The Traceflow tracking script is loaded asynchronously and has no impact on your page load time or Core Web Vitals scores.
How does Traceflow identify website visitors by email?
Traceflow matches website sessions to email contacts using a first-party cookie set when a visitor clicks a link from your email. No third-party cookies are required.
What happens if a visitor blocks cookies?
Anonymous sessions are still tracked (without email identity). The journey timeline for known contacts will only include sessions where identity was established.
Can I use Traceflow without connecting email?
Yes. The website analytics, heatmaps, and visitor tracking features work without an email integration. Email integration is optional but unlocks the full customer journey experience.
How long is data retained?
By default, journey data is retained for 24 months. You can configure retention periods per website in Settings → Data Retention.
Is there a free plan?
Yes, Traceflow offers a free plan with limited tracked visits per month, one website, and basic analytics. See our Pricing page for full plan details.