Skip to main content
Documentation

Start with the signal you need to measure.

Start with visibility, then add browser or crawler capture only for the signal you need.

Start here#

Choose an instrumentation mode#

Choose your framework#

Each framework guide covers Human Analytics and AI Crawler Analytics where the framework supports them, and starts with a prompt for your coding agent.

JavaScript and TypeScript#

Server and CMS#

Hosting integrations#

No server code, or pages served from a CDN cache? Capture AI crawlers from your host's logs or an edge Worker instead. See Hosting integrations.

Framework not listed?#

Use the platform pattern that matches your architecture:

  • a global site template for the browser script;
  • a server, edge, reverse-proxy, middleware, or plugin hook for crawler requests, or your host's logs (see AI Crawler Analytics);
  • environment variables for server secrets;
  • route exclusions for APIs, static assets, images, robots files, and sitemaps.

Contact support before inventing a public SDK API or payload.

Keys and data boundaries#

Publishable write key#

Use the publishable key (vha_pk_…) in browser tracking. It identifies the site's public ingest configuration and only accepts events from the website's allowed origins.

Server ingest secret#

Use the server secret (vha_sk_…) only in server, edge, proxy, middleware, or protected backend code. Never hard-code it in committed source or expose it to the browser. See Keys and secrets.

Ingest endpoint#

Use Virent's default endpoint unless the implementation requires an approved custom or proxied endpoint, such as a first-party relay.

Sensitive data#

Do not send passwords, payment-card data, health data, government identifiers, precise location, API secrets, or other sensitive personal information unless Virent has expressly agreed in writing to process it.

Product guides#

More resources#

Need help choosing the right integration?

Describe your framework, hosting layer, and the signals you need to measure. Do not send passwords, API keys, server secrets, or sensitive customer data.