ClickStream

ClickStream is a first-party event collection and Signals platform. It helps your application classify traffic, read visitor context, and keep human, crawler, monitoring, automation, and review traffic in separate lanes.

This site is the developer reference for installing ClickStream, instrumenting your application, and consuming the real-time Signals API from your own code.

Browser installs can start before DNS. Add the snippet using the shared collector and your registered origin to see data immediately. A first-party CNAME is the recommended durability and privacy upgrade. Native mobile and server properties use dedicated provenance-exempt keys against https://feynman.clickstream.com and do not require DNS. The Install guide routes each property type correctly.

Who this is for

• Developers and technical founders installing ClickStream for the first time — start with the install guide and first-party tracking setup.
• Application engineers integrating real-time visitor context into page logic — see the Signals API reference.
• Data + platform teams streaming labeled events into their own systems — see the Signals Feed WebSocket.

How ClickStream is organized

• Collector ingests events from opted-in visitors over HTTPS. Browser events are accepted from a tenant's registered origin; the shared collector works before a first-party CNAME is active.
• Signals layer labels traffic into human, bot, automation, search crawler, answer-engine, and internal QA lanes.
• Language + geo intelligence derives each visitor's primary language, hidden-demand languages, active hours, and town-level location from first-party signals — surfaced in analytics and on getVisitor().locale.
• Optional enrichment can attach visitor details when a site is allowed to use it and the visitor produces a matchable signal.
• People exports download the first-party people ClickStream already collected or resolved as CSV, subject to package limits and privacy controls.
• Advanced destinations and provider-generated audiences are deferred from the current sell-now path; existing direct documentation remains available for account migrations.
• Dashboard at einstein.clickstream.com is the client surface: Traffic, People, Segments, Sites/Setup, and Billing.
• @clickstreamhq/sdk — public helper that installs the browser pixel from your first-party tracking domain.
• @clickstreamhq/signals — read real-time scores from page code.
• @clickstreamhq/react and @clickstreamhq/next — framework adapters.
• Mobile apps — direct event ingestion for native iOS, Android, and React Native screens.

The shortest path to live data

1. Sign up at einstein.clickstream.com and create a site. The dashboard mints your API key.
2. Add the code from the dashboard. The shared collector accepts the first browser events from your registered site origin, so you can confirm data flow before DNS.
3. Optionally provision a tracking subdomain. The dashboard walks you through adding a CNAME record — e.g. t.example.com → ClickStream's collector. We verify the CNAME and provision SSL automatically; once active, use it as the first-party endpoint.

Full walkthrough: Install → First-party tracking (recommended).

Conventions used in this documentation

• Commands in shell blocks assume a macOS or Linux environment and pnpm as the package manager.
• API tokens in code samples use the prefix cs_test_; production keys use cs_live_.
• Browser examples use t.example.com or t.yourdomain.com; replace them with your registered first-party tracking domain. Native/server examples use feynman.clickstream.com as shown.
• Time values are in milliseconds unless otherwise noted.
• Score values are on a 0–100 scale unless otherwise noted.

Need help?

• Email support@clickstream.com for product questions.
• Email security@clickstream.com for security disclosures — security reports are acknowledged promptly.
• Email billing@clickstream.com for billing questions.