Event Schema

The event schema defines the structure and properties of your analytics events.

Configuration

Event

Field	Type	Required	Description
name	string	yes	Event name
description	string	no	Event context description
dimensions	string[] or { included: string[], excluded: string[] }	no	Event dimension associations
passthrough	boolean	no	Allow arbitrary properties
properties	Property[]	no	Event properties

Example

events:
  page_view:
    name: Page View
    description: Triggered when a user views a page.
    properties:
      - name: Page Name
        description: The name of the page that was viewed.
        type: string

  add_user:
    name: Add User
    description: Triggered when an admin adds a user to their team.
    properties:
      - name: Role
        description: The role of the user that was added.
        type: [admin, member]