Internal Events

Reserved $-prefixed event types produced automatically by the Vanta SDK and API.

Reserved event types

Vanta reserves event types that begin with $. The SDK and API emit these automatically, and you never send them directly. They power the standard analytics you rely on:

  • $page - page views, captured automatically by the web SDK
  • $identify - a user was identified
  • $group - a group was associated
  • $measure - a measurement was recorded
  • $increment - a counter was incremented
  • $decrement - a counter was decremented
  • $error - an error was recorded

How internal events are generated

You never construct these events by hand. Instead, they are produced by the SDK methods that model the underlying concept. Calling identify() emits an $identify event, calling measure() emits a $measure event, and so on.

Seeing internal events

Internal events appear alongside your custom events in the dashboard and in event queries. You can tell them apart by the leading $ in their type. Custom events never use that prefix, so any type starting with $ is internal.

Querying page views

To query page views in analytics, filter events where type equals $page:

typescript
import { Vanta, filter } from '@vanta-dev/node'

const vanta = new Vanta({
  apiKey: process.env.VANTA_API_KEY,
})

const pageViews = await vanta.queryEvents({
  filters: filter('type', 'equals', '$page'),
})

Use $ as a prefix filter to see all internal events at once, or combine an internal type with a custom filter to narrow down on a specific behavior.