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.

Every ClickStream install runs on your own domain. We do not support direct public use of our ingestion hostnames. You must point a CNAME on your own domain (t.yourdomain.com) at our collector before the SDK will accept events. The Install guide + First-party tracking pages walk through the dashboard-guided provisioning.

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 first-party HTTPS. Only reachable through a tenant's registered tracking domain.
• Signals layer labels traffic into human, bot, automation, search crawler, answer-engine, and internal QA lanes.
• Optional enrichment can attach visitor details when a site is allowed to use it and the visitor produces a matchable signal.
• Dashboard at einstein.clickstream.com is the operator surface: Intelligence, Human + AI Traffic, Visitors, form analytics, 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. 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.
3. Install the SDK with one <script> tag pointing at your tracking domain. Everything — SDK delivery, event ingest, SDK updates — runs through that single first-party endpoint.

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

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_.
• Hostnames in examples always use t.example.com or t.yourdomain.com — replace with your registered first-party tracking domain.
• 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.