Browser Event API

Use the TinyAnalytics tracking script’s browser API to record visitor activity. Install the tracking script, then call methods on window.tinyanalytics; you do not need an API key or a custom HTTP client.

window.tinyanalytics.event('signup', { plan: 'pro' })

Never put a TinyAnalytics API key in client-side code. Browser collection is keyless, and the tracking script supplies the site and page context for you.

Available event methods

Method	What it records
`pageview(path?)`	A pageview for the current URL, or for the path you pass.
`event(name, props?)`	A named custom event with optional properties.
`trackOutbound(url, text?, target?)`	An outbound-link event.
`trackError(error, metadata?)`	A handled JavaScript error with optional metadata.

The tracker automatically records initial pageviews and SPA route changes by default. Call pageview() yourself only when you have disabled automatic pageviews or need to supply a custom path.

Send a custom event

Call event() after the tracking script has loaded:

window.tinyanalytics.event('checkout_completed', {
  plan: 'pro',
  seats: 5
})

string

required

A short, stable event name such as signup or checkout_completed. An empty name is rejected in the browser.

object

Optional JSON properties used for breakdowns and filters. The serialized object can be up to 8 KB.

Keep the event name stable and put values that change into properties. For example, use one checkout_completed event with a plan property instead of a separate event name for every plan.

Attach revenue

Put the reserved revenue and currency properties on a custom event:

window.tinyanalytics.event('purchase', {
  revenue: 49.99,
  currency: 'USD',
  plan: 'pro'
})

revenue accepts a positive number or numeric string in major currency units.
currency is a three-letter currency code such as USD, EUR, or GBP.

See Revenue analytics for reporting behavior, refunds, and currency conversion.

Send a manual pageview

Automatic pageviews and SPA route tracking cover most sites. If you turn automatic pageviews off, send one when your app finishes navigation:

window.tinyanalytics.pageview('/account/billing')

Omit the argument to use the browser’s current location.

Send an outbound-link event

Outbound links are captured automatically by default. Use trackOutbound() when your app opens an external destination without a normal anchor click:

window.tinyanalytics.trackOutbound(
  'https://partner.example.com',
  'Open partner dashboard',
  '_blank'
)

Track a handled error

Automatic error capture sees uncaught errors when you enable it. Use trackError() inside a catch block or error boundary for an error your app handles:

try {
  await submitCheckout()
} catch (error) {
  window.tinyanalytics.trackError(error, { step: 'checkout' })
}

See JavaScript error tracking for automatic capture and privacy limits.

Call the API after the script loads

The script loads with defer, so event handlers and app lifecycle callbacks can call it normally. Guard code that may run during early page boot:

if (window.tinyanalytics) {
  window.tinyanalytics.event('hero_viewed')
}

Verify

Trigger the browser call

Open your site in a browser and perform the action that calls event(), pageview(), trackOutbound(), or trackError().

Check the matching report

Open Events for custom and outbound events, Pages for pageviews, or Errors for JavaScript errors. The new record should appear within a few seconds.

The client-side integration is working when the browser action appears in its matching TinyAnalytics report.

Custom events

Design stable event names and useful properties.

Browser identity

Identify signed-in users and update traits from client-side code.

Configure the tracking script

Control automatic pageviews and capture options.

Verify installation

Diagnose script loading and event delivery.

Start here

Browser APIs

Data API

Authentication & tools

Endpoint reference

Available event methods

Send a custom event

Attach revenue

Send a manual pageview

Send an outbound-link event

Track a handled error

Call the API after the script loads

Verify

Custom events

Browser identity

Configure the tracking script

Verify installation

​Available event methods

​Send a custom event

​Attach revenue

​Send a manual pageview

​Send an outbound-link event

​Track a handled error

​Call the API after the script loads

​Verify

​Related

Custom events

Browser identity

Configure the tracking script

Verify installation

Available event methods

Send a custom event

Attach revenue

Send a manual pageview

Send an outbound-link event

Track a handled error

Call the API after the script loads

Verify

Related