# Mitzu Documentation

> Mitzu runs product analytics - funnels, retention, segmentation, journeys and user lookup - directly on your data warehouse, without copying event data out of it.

The full text of every page below is available as a single file: https://docs.mitzu.io/llms-full.txt

The REST API is described by an OpenAPI spec: https://docs.mitzu.io/contracts/api/v1/api.yaml

## Get Started

- [Mitzu environments](https://docs.mitzu.io/connect-mitzu): Overview of the different ways to connect Mitzu with your data warehouse.
- [Quick Start with Mitzu](https://docs.mitzu.io/): Get started with Mitzu. Whether you have a data warehouse or not, this guide will help you get started.
- [Set up Mitzu on your data warehouse](https://docs.mitzu.io/setup-mitzu): Let's quickly set up Mitzu on top of your data warehouse.
- [Set up a data warehouse](https://docs.mitzu.io/setup-data-warehouse): Set up a data warehouse from scratch and centralize all your data in under 60 minutes.
- [CSV Uploads](https://docs.mitzu.io/get_started/csv-uploads): Upload CSV files to create queryable data tables in Mitzu

## Mitzu Agent

- [Mitzu Agent](https://docs.mitzu.io/mitzu-agent): Overview of Mitzu's AI-powered analytics agent.
- [Analytics Agent](https://docs.mitzu.io/analytics-agent): How to use Mitzu's AI analytics agent to ask questions, create insights, and explore your data.
- [Planning Mode](https://docs.mitzu.io/planning-mode): How to use planning mode to review and approve a step-by-step plan before the agent starts working.
- [Scheduled Agents](https://docs.mitzu.io/scheduled-agents): Run a Mitzu agent automatically on a schedule and get emailed only when the results meet a condition you define.
- [Configuration Agent](https://docs.mitzu.io/configuration-agent): How to use Mitzu's AI configuration agent to set up your data warehouse tables.
- [Slack Agent](https://docs.mitzu.io/slack-agent): How to use Mitzu Agent directly in Slack for quick analytics questions.
- [Mitzu MCP Server](https://docs.mitzu.io/mcp-server): Connect Claude, Cursor, ChatGPT, and other AI tools to your Mitzu workspace via the Model Context Protocol.
- [AI Data & Privacy](https://docs.mitzu.io/ai-data-privacy): How Mitzu Agent handles your data — metadata isolation, no model training, per-workspace controls, and retention.

## Warehouse Connectors

- [Warehouse integrations](https://docs.mitzu.io/warehouse-integrations): Every data warehouse and query engine Mitzu connects to, including Snowflake, BigQuery, Databricks, Redshift, Athena, Trino, ClickHouse and Postgres.
- [AWS Athena](https://docs.mitzu.io/aws-athena): Setup AWS Athena Integration To Mitzu
- [Big Query](https://docs.mitzu.io/bigquery): Setup Google Big Query Integration To Mitzu
- [ClickHouse](https://docs.mitzu.io/clickhouse): Setup ClickHouse Integration To Mitzu
- [Databricks](https://docs.mitzu.io/databricks): Setup Databricks Integration To Mitzu
- [Microsoft Fabric](https://docs.mitzu.io/fabric): Setup Microsoft Fabric Integration To Mitzu
- [Firebolt](https://docs.mitzu.io/firebolt): Firebolt integration to Mitzu
- [PostgreSQL](https://docs.mitzu.io/postgresql): Setup PostgreSQL Integration To Mitzu
- [AWS Redshift](https://docs.mitzu.io/redshift): Setup AWS Redshift Integration To Mitzu
- [Snowflake](https://docs.mitzu.io/snowflake): Setup Snowflake Integration To Mitzu
- [Starburst.io](https://docs.mitzu.io/starburst): Setup Starburst.io Integration To Mitzu
- [Self-hosted Trino / Presto](https://docs.mitzu.io/trino): Setup self-hosted Trino/Presto Integration To Mitzu
- [Uploaded CSV](https://docs.mitzu.io/uploaded-csv): Upload a CSV file as your data source instead of connecting to a data warehouse

## Data Models

- [Introduction](https://docs.mitzu.io/data-modeling): Basics of data modeling for Mitzu
- [Event Modeling](https://docs.mitzu.io/event-modeling): On this page you will find the three event data model architectures that Mitzu supports

## Data Indexing

- [Data Indexing](https://docs.mitzu.io/indexing): Explaining how Mitzu indexes your data warehouse to transform your insights into SQL queries
- [Supported Data Types](https://docs.mitzu.io/data_indexing/supported-data-types): Page lists the supported data types for each data warehouse

## Insights Page

- [Insights Basics](https://docs.mitzu.io/insights-basics): Insights basics
- [Segmentation](https://docs.mitzu.io/segmentation): Segmentation
- [Funnels in Mitzu](https://docs.mitzu.io/funnel): Learn the basics of funnels
- [Retention](https://docs.mitzu.io/retention): Learn the basics of retention
- [Journeys in Mitzu](https://docs.mitzu.io/journey): Journeys
- [User and group focus mode](https://docs.mitzu.io/user-and-group-focus): User and group focus mode
- [User and groups lookup](https://docs.mitzu.io/user-and-group-lookup): User and group lookup

## Dashboards

- [Dashboards](https://docs.mitzu.io/dashboards/edit-dashboard): Group insights, text, and dividers into a single live view — arrange them on a flexible grid, filter and refresh them together, and edit with AI.
- [Publishing and Sharing Dashboards](https://docs.mitzu.io/dashboards/publishing-dashboard): Make a dashboard publicly accessible and embed it in external websites or applications.

## Other Assets

- [Annotations](https://docs.mitzu.io/other_assets/annotations): Annotations are shared information that is visible on all charts and dashboards.
- [Cohorts](https://docs.mitzu.io/other_assets/cohorts): Cohorts
- [Saved Insights](https://docs.mitzu.io/other_assets/saved-insights): Saved Insights consist of user-created insights that are stored either as standalone results or to be included in a dashboard.

## Data Catalog

- [Custom Events](https://docs.mitzu.io/custom-events): Custom events
- [Dimension Property Catalog](https://docs.mitzu.io/dimension-property-catalog): Dimension property catalog
- [Event Catalog](https://docs.mitzu.io/event-catalog): Event catalog
- [Event Property Catalog](https://docs.mitzu.io/event-property-catalog): Event property catalog

## Workspace Settings

- [Generic settings](https://docs.mitzu.io/generic-settings): Generic settings
- [Connection settings](https://docs.mitzu.io/connection-settings): Connection settings
- [Event tables](https://docs.mitzu.io/event-tables): Event tables
- [Dimension tables](https://docs.mitzu.io/dimension-tables): Dimension tables
- [Entities](https://docs.mitzu.io/entities): Entities
- [Insight settings](https://docs.mitzu.io/insight-settings): Insight settings
- [Performance settings](https://docs.mitzu.io/performance-settings): Performance settings
- [AI settings](https://docs.mitzu.io/ai-settings): AI settings
- [Indexing settings](https://docs.mitzu.io/indexing-settings): Indexing settings
- [Statistics](https://docs.mitzu.io/statistics): Statistics
- [Members](https://docs.mitzu.io/manage-members): Manage members and roles in your organisation
- [API keys](https://docs.mitzu.io/api-keys): Manage API keys
- [Single sign-on](https://docs.mitzu.io/single-sign-on): SSO with AWS Cognito, Google SSO, or OIDC
- [Billing and Subscription](https://docs.mitzu.io/billing-and-subscription): Billing and Subscription
- [Query Admin](https://docs.mitzu.io/query-admin): Inspect and cancel SQL queries running against your data warehouse
- [Slack Integration](https://docs.mitzu.io/slack-integration): Connect Slack to Mitzu to receive alerts and chat with Mitzu AI

## v1

- [Mitzu API](https://docs.mitzu.io/api/v1/mitzu-api): ## Mitzu API
- [Add an event table](https://docs.mitzu.io/api/v1/add-event-table): Adds a new event table to the project.
- [Bulk update event catalog](https://docs.mitzu.io/api/v1/bulk-update-event-catalog): Bulk updates the `display_name` and `description` of one or more event catalog entries.
- [Delete an event table](https://docs.mitzu.io/api/v1/delete-event-table): Deletes the event table identified by its ID from the project.
- [Get event usage stats](https://docs.mitzu.io/api/v1/get-event-usage-stats): Returns the latest event usage statistics for the project from the cache.
- [Get task statuses](https://docs.mitzu.io/api/v1/get-tasks): Returns the status of one or more tasks. At least one task_id query parameter is required. Maximum 50 tasks can be queried at once.
- [Index all event tables](https://docs.mitzu.io/api/v1/index-all-event-tables): Triggers indexing of all event tables in the project
- [Index dimension table](https://docs.mitzu.io/api/v1/index-dimension-table): Triggers indexing of the selected dimension table
- [Index event table by ID](https://docs.mitzu.io/api/v1/index-event-table-by-id): Triggers indexing of the selected event table by its ID. Disabled tables return a 400 response.
- [Index a single event table by name and schema](https://docs.mitzu.io/api/v1/index-event-table-by-name): Triggers indexing of a specific event table identified by table name and schema. Disabled tables return a 400 response.
- [List projects](https://docs.mitzu.io/api/v1/list-projects): List projects
- [Project details](https://docs.mitzu.io/api/v1/project-details): Returns the project details including the configured tables
- [Start event usage stats gathering](https://docs.mitzu.io/api/v1/start-event-usage-stats): Starts an asynchronous job that gathers event usage statistics for the project:
- [Update an event table](https://docs.mitzu.io/api/v1/update-event-table): Partially updates the configuration of an existing event table identified by its ID.

## schemas

- [Add event table request](https://docs.mitzu.io/api/v1/schemas/add-event-table-request): The configuration of a new event table.
- [Bulk update event catalog request](https://docs.mitzu.io/api/v1/schemas/bulk-update-event-catalog-request)
- [Bulk update event catalog response](https://docs.mitzu.io/api/v1/schemas/bulk-update-event-catalog-response)
- [Delete event table response](https://docs.mitzu.io/api/v1/schemas/delete-event-table-response)
- [Dimension table details](https://docs.mitzu.io/api/v1/schemas/dimension-table-details): Contains details about a dimension table
- [Event catalog entry](https://docs.mitzu.io/api/v1/schemas/event-catalog-entry): The state of an event catalog entry after a bulk update.
- [Event catalog update item](https://docs.mitzu.io/api/v1/schemas/event-catalog-update-item): A single event catalog update.
- [Event table details](https://docs.mitzu.io/api/v1/schemas/event-table-details): Contains details about an event table
- [Event usage stat item](https://docs.mitzu.io/api/v1/schemas/event-usage-stat-item): Usage statistics for a single event.
- [Event usage stats response](https://docs.mitzu.io/api/v1/schemas/event-usage-stats-response): The latest cached event usage statistics for a project.
- [Get tasks response](https://docs.mitzu.io/api/v1/schemas/get-tasks-response): Contains a mapping of task IDs to their status information. Missing tasks are not included in the response.
- [Index all tables response](https://docs.mitzu.io/api/v1/schemas/index-all-tables-response)
- [List project response](https://docs.mitzu.io/api/v1/schemas/list-project-response)
- [Project details](https://docs.mitzu.io/api/v1/schemas/project-details): Contains project details including the configured tables
- [Project Info](https://docs.mitzu.io/api/v1/schemas/project-info): Contains basic information about a project.
- [Task info](https://docs.mitzu.io/api/v1/schemas/task-info): Contains basic information about a task.
- [Update event table request](https://docs.mitzu.io/api/v1/schemas/update-event-table-request): A partial update of an existing event table. Only the fields present in the request