Goals and custom events

Call window.v5, mark an element with data-v5-event, then create a matching goal in the dashboard.

window.v5

anywhere.ts

// Custom event with props
window.v5('signup', { plan: 'pro' })

// A pageview you triggered yourself
window.v5('pageview')

window.v5 is assigned after the script boots. If you fire events from a bundle that may load first, guard with window.v5?.('signup') or call after load.

data-v5-event

index.html

<button data-v5-event="Signup">Create account</button>
<a href="/pricing.pdf" data-v5-event="Pricing PDF">Download</a>

Clicks on [data-v5-event] win over the automatic outbound / download detectors on the same element.

Goals

Create a goal in the dashboard (or POST /api/sites/{id}/goals) with the same name. Conversion rates are filterable by actor, so agents never inflate them. See Dashboard → Goals.

Props

Props are a JSON object on the event (p). Use them for plan names, variants, or file URLs. Do not put emails, user ids, or anything that could identify a person — the privacy model assumes event props are non-identifying. The API accepts at most 64 KB per request.