@vanta-dev/types

Shared TypeScript types for the Vanta event tracking platform. Used internally by the Vanta SDKs and API, but also available as a standalone package if you need typed access to the Vanta data model.

Installation

npm install @vanta-dev/types

What it provides

This package contains TypeScript interfaces and type definitions for:

• Events - Event, EventContext, EventQuery, EventListResponse
• Analytics - query and result types for count, group, timeseries, aggregate, and unique analytics
• Users and Groups - User, Group, IdentifyRequest
• Metrics - Metric, MetricSubmit, MetricQuery, MetricQueryResult, MetricTimeseriesResult
• Uptime - Monitor, Heartbeat, Incident, UptimeStats, MonitorCreate, MonitorUpdate
• Projects - Project, ApiKey, Source, ProjectMember, ProjectInvitation
• Query helpers - filter(), and(), or(), timeRange() functions for building filter expressions

Usage

import type { Event, EventQuery } from '@vanta-dev/types'
import { filter, and, timeRange } from '@vanta-dev/types'

const query: EventQuery = {
  filters: and(
    filter('type', 'equals', 'purchase'),
    filter('data.amount', 'gt', 100),
  ),
  time: timeRange('2025-01-01T00:00:00Z', '2025-02-01T00:00:00Z'),
}

Documentation

Read the full documentation at vanta.pancake.wtf.