diff --git a/fern/docs.yml b/fern/docs.yml index 02b352f8f..62bf5b256 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -331,6 +331,12 @@ navigation: path: test/voice-testing.mdx icon: fa-light fa-volume-high + - section: Observability + contents: + - page: Boards + path: observability/boards-quickstart.mdx + icon: fa-light fa-chart-line + - section: Phone numbers contents: - page: Free Vapi number diff --git a/fern/observability/boards-quickstart.mdx b/fern/observability/boards-quickstart.mdx new file mode 100644 index 000000000..8005742aa --- /dev/null +++ b/fern/observability/boards-quickstart.mdx @@ -0,0 +1,455 @@ +--- +title: Boards quickstart +subtitle: Create custom analytics dashboards in minutes +slug: observability/boards-quickstart +--- + +## Overview + +Boards is Vapi's custom analytics dashboard system that enables you to create visual dashboards with real-time insights. Build drag-and-drop dashboards tailored to your teams, use cases, and reporting needs—all through the Vapi Dashboard interface. + +**Boards allow you to:** + +- Add and configure insights (bar charts, line charts, pie charts, text metrics) +- Apply global time range filters and granularity settings +- Build queries visually with field selectors and filter builders +- Create calculated metrics using formulas +- Drag, resize, and position widgets on a responsive grid + +### When to use Boards + +Boards are ideal for: + +- **Sales tracking** - Monitor call volume, conversion rates, and booking metrics +- **Support metrics** - Track resolution times, issue categories, and customer satisfaction +- **Cost monitoring** - Analyze spending patterns, cost per call, and budget tracking +- **Performance analysis** - Measure assistant performance, call quality, and efficiency + +## What you'll build + +A Sales Performance Dashboard that displays: + +- Total calls and bookings for today +- Call volume trends over the past 30 days +- Bookings by assistant +- Call outcomes distribution +- Booking conversion rate (calculated metric) + +## Prerequisites + + + + Account with Boards access enabled + + + Existing call data helps create meaningful visualizations + + + + + Boards are accessible through the Vapi Dashboard at + [dashboard.vapi.ai](https://dashboard.vapi.ai) + + +## Step 1: Access Boards + +Navigate to the Boards feature in your dashboard. + +1. Log into your Vapi Dashboard at [dashboard.vapi.ai](https://dashboard.vapi.ai) +2. Click **Boards** in the left sidebar (under the "Reporting" or "Analytics" section) +3. Your board will be automatically created on first visit + + + Your board is created automatically when you first access the Boards page. + You'll see an empty 6-column grid layout where you can add insights. + + +## Step 2: Add your first insights + +Start with key performance indicators that show single important numbers. + + + + 1. Click **Add Widget** or the **+** button + 2. Select **Text** widget type + 3. Configure the insight: + - **Name**: "Total Calls Today" + - **Data Source**: Select "Calls" + - **Metric**: Choose "Count" + - **Field**: Select "Call ID" + - **Time Range**: Set to "Last 24 hours" + 4. Click **Preview** to see the result + 5. Click **Add to Board** + 6. Drag the insight to your desired position + 7. Resize if needed by dragging the bottom-right corner + + + The number updates in real-time. Hover over the insight to see additional details. + + + + + Repeat the process for a second insight: + + 1. Click **Add Widget** → **Text** + 2. Configure: + - **Name**: "Total Bookings Today" + - **Data Source**: Calls + - **Metric**: Count of Call ID + - **Time Range**: Last 24 hours + 3. Add a filter to count only successful bookings: + - Click **Add Filter** + - **Field**: Status + - **Operator**: equals (=) + - **Value**: "ended" + 4. Click **Add to Board** + 5. Position it next to your first insight + + + +## Step 3: Create visualizations + +Add charts to visualize trends and patterns in your data. + + + + Create a bar chart showing calls by assistant: + + 1. Click **Add Widget** + 2. Select **Bar Chart** + 3. Configure: + - **Name**: "Calls by Assistant" + - **Data Source**: Calls + - **Metric**: Count of Call ID + - **Group By**: Select "Assistant" from dropdown + - **Time Range**: Last 7 days + - **Group By Time**: Day + 4. Click **Preview** to see bars showing calls per assistant per day + 5. Customize appearance (optional): + - **X-axis Label**: "Date" + - **Y-axis Label**: "Number of Calls" + - **Colors**: Choose color scheme + 6. Click **Add to Board** + + +{" "} + + + Track call volume over time: 1. Click **Add Widget** 2. Select **Line Chart** + 3. Configure: - **Name**: "Call Volume Trend" - **Data Source**: Calls - + **Metric**: Count of Call ID - **Time Range**: Last 30 days - **Group By + Time**: Day 4. Optional - Add multiple lines: - Click **Add Another Metric** - + Configure second metric (e.g., "Average Duration") 5. Click **Add to Board** + + Line charts are ideal for showing trends over time. Use them to identify + patterns and anomalies. + + + + + Show distribution of call outcomes: + + 1. Click **Add Widget** + 2. Select **Pie Chart** + 3. Configure: + - **Name**: "Calls by Status" + - **Data Source**: Calls + - **Metric**: Count of Call ID + - **Group By**: Select "Status" + - **Time Range**: Last 7 days + 4. Click **Add to Board** + + + Pie charts don't have time series grouping. They show distribution across categories only. + + + + +## Step 4: Apply filters to insights + +Filter data to focus on specific segments or conditions. + + + + Open any insight's settings and add filters: + + 1. Click the **⚙️ (settings)** icon on any insight + 2. Click **Add Filter** button + 3. Configure first filter: + - **Field**: Select "Status" from dropdown + - **Operator**: Choose "equals" (=) + - **Value**: Type or select "ended" + 4. Click **Add Another Filter** for multiple conditions + 5. Example second filter: + - **Field**: Cost + - **Operator**: Greater than (>) + - **Value**: 0.50 + 6. Click **Save** + + **Common filter patterns:** + - Filter by assistant: `Assistant ID =