> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vizapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboard Guide

> Master your VizAPI.ai dashboard - your control center for visual data extraction and template management

<img style={{ borderRadius: '0.5rem' }} src="https://vizapi.ai/images/dashboard-overview.png" alt="VizAPI.ai Dashboard" />

## Dashboard Overview

Your dashboard is mission control for all your visual data extraction needs. Here's everything you need to know to navigate like a pro and master advanced template management.

<CardGroup cols={2}>
  <Card title="Template Management" icon="wand-magic-sparkles">
    Create, edit, and version extraction templates
  </Card>

  <Card title="API Keys & Security" icon="key">
    Control access, environments, and security settings
  </Card>

  <Card title="Usage Analytics" icon="chart-line">
    Monitor credits, performance, and template success rates
  </Card>

  <Card title="Account Settings" icon="gear">
    Preferences, billing, and advanced configurations
  </Card>
</CardGroup>

## Home Dashboard

### Quick Actions Hub

<Tabs>
  <Tab title="Templates">
    **Browse Library**: Explore our curated library of 50+ pre-built templates for common extraction tasks.

    **Featured Templates**: Plant Disease Spotter, Object Detector, Pose Analyzer, Quality Inspector.

    **Quick Deploy**: One-click deployment with optional customization.
  </Tab>

  <Tab title="New Extraction">
    **Create Custom**: Build your own extraction template from scratch using our visual editor.

    **Field Types**: 7 comprehensive types including string, number, date, boolean, enum, object, and image.

    **AI Assistance**: Smart field suggestions based on your content.
  </Tab>

  <Tab title="API Integration">
    **Code Examples**: Ready-to-use code snippets in popular languages.

    **Languages**: Python, JavaScript, Go, PHP, cURL with authentication headers.

    **Version Control**: Access specific template versions in your API calls.
  </Tab>
</Tabs>

### Performance Metrics

<AccordionGroup>
  <Accordion title="Total Templates" icon="database">
    Count of all extraction templates you've created. Includes both custom and deployed pre-built templates.

    **Template Categories**:

    * Custom templates: Your unique creations
    * Deployed templates: Pre-built templates you're using
    * Draft templates: Work in progress
  </Accordion>

  <Accordion title="API Calls This Month" icon="chart-line">
    Monthly API requests across all templates with success rate tracking.

    **Metrics Include**:

    * Total successful extractions
    * Failed requests (with error breakdown)
    * Average confidence scores
    * Credits consumed
  </Accordion>

  <Accordion title="Active Templates" icon="calendar">
    Templates used in the past 7 days with performance indicators.

    **Performance Indicators**:

    * Green: `>90%` success rate
    * Yellow: `80-90%` success rate
    * Red: `<80%` success rate
  </Accordion>

  <Accordion title="Top Performing Template" icon="star">
    Your highest-traffic template with detailed analytics.

    **Click to View**:

    * Confidence score trends
    * Field-level performance
    * Usage patterns
    * Version history
  </Accordion>
</AccordionGroup>

## Template Management Hub

### My Templates Overview

Advanced template management with comprehensive filtering and sorting:

#### Template Table

| Column           | Description                   | Features                     |
| ---------------- | ----------------------------- | ---------------------------- |
| **Name**         | Template display name         | Click to edit, sortable      |
| **Version**      | Current version (e.g., 1.2)   | Version history access       |
| **Category**     | Template type/category        | Filter by category           |
| **Created**      | Creation timestamp            | Sort by date                 |
| **Last Used**    | Most recent API call          | Activity indicator           |
| **Success Rate** | Extraction success percentage | Performance indicator        |
| **Confidence**   | Average confidence score      | Quality indicator            |
| **Actions**      | Quick actions menu            | Edit, clone, analyze, delete |

#### Advanced Filtering

<CardGroup cols={2}>
  <Card title="Performance Filters" icon="filter">
    * **High Performers**: `>95%` success rate
    * **Needs Attention**: `<85%` success rate
    * **Recently Used**: Active in last 7 days
    * **Draft Status**: Unpublished templates
  </Card>

  <Card title="Content Filters" icon="tag">
    * **By Category**: Agriculture, Medical, Security, Quality Control
    * **By Field Types**: Templates using specific field types
    * **By Language**: Multi-language enabled templates
    * **By Version**: Show specific version ranges
  </Card>
</CardGroup>

### Template Actions Menu

<CardGroup cols={2}>
  <Card title="Edit Template" icon="pencil">
    **Visual Editor**: Modify fields, descriptions, and settings
    **Version Control**: Save as new version or update current
    **Live Testing**: Test changes with real images
  </Card>

  <Card title="Clone Template" icon="copy">
    **Smart Duplication**: Create variations for A/B testing
    **Bulk Operations**: Clone multiple templates at once
    **Cross-Category**: Adapt templates for different use cases
  </Card>

  <Card title="Performance Analytics" icon="chart-bar">
    **Detailed Metrics**: Field-level success rates and confidence scores
    **Usage Trends**: Daily/weekly/monthly usage patterns
    **Error Analysis**: Common failure points and solutions
  </Card>

  <Card title="API Integration" icon="code">
    **Code Snippets**: Copy-paste integration examples
    **Webhook Setup**: Real-time extraction notifications
    **Batch Processing**: Multi-image extraction examples
  </Card>
</CardGroup>

## Template Library

### Enhanced Browsing Experience

#### Smart Categories

<CardGroup cols={2}>
  <Card title="Agriculture & Farming" icon="leaf">
    **Templates**: Plant disease detection, crop monitoring, livestock analysis
    **Use Cases**: Precision farming, yield optimization, health monitoring
    **Key Features**: Multi-species support, severity classification
  </Card>

  <Card title="Medical & Diagnostics" icon="stethoscope">
    **Templates**: X-ray analysis, skin lesion detection, diagnostic imaging
    **Use Cases**: Healthcare diagnostics, medical screening, triage
    **Key Features**: HIPAA compliance, confidence scoring
  </Card>

  <Card title="Quality Control" icon="shield-check">
    **Templates**: Defect detection, surface inspection, compliance monitoring
    **Use Cases**: Manufacturing QC, product inspection, safety compliance
    **Key Features**: Pass/fail detection, defect classification
  </Card>

  <Card title="Security & Surveillance" icon="shield">
    **Templates**: Object detection, crowd analysis, threat assessment
    **Use Cases**: Security monitoring, access control, safety management
    **Key Features**: Real-time analysis, alert systems
  </Card>
</CardGroup>

#### Advanced Search & Discovery

* **Smart Search**: Find templates by name, description, or field types
* **Category Filtering**: Filter by image type or use case
* **Performance Sorting**: Sort by success rate, popularity, or recency
* **Tag System**: Custom tags for better organization
* **Favorite Templates**: Star templates for quick access

### Template Deployment Workflow

<Steps>
  <Step title="Discover & Preview">
    Browse categories or search for templates. Click "Preview" to see:

    * Sample extractions with confidence scores
    * Field structure and data types
    * Performance metrics and user ratings
  </Step>

  <Step title="Test & Validate">
    Upload your own images to test template performance:

    * Real-time extraction results
    * Confidence score analysis
    * Field-by-field validation
  </Step>

  <Step title="Deploy & Customize">
    Click "Use Template" to deploy:

    * Optional field customization
    * Version selection (latest or specific)
    * Environment targeting (dev/staging/prod)
  </Step>

  <Step title="Monitor & Optimize">
    Track performance and make improvements:

    * Success rate monitoring
    * Confidence score trends
    * Version comparison analytics
  </Step>
</Steps>

## Advanced Template Features

### Template Versioning Control

<AccordionGroup>
  <Accordion title="Version Management" icon="code-branch">
    **Create Versions**: Save template changes as new versions (1.0, 1.1, 2.0)

    **Version Comparison**: Side-by-side comparison of different versions

    **Rollback Capability**: Instantly revert to previous versions

    **API Version Control**: Specify exact versions in API calls for production stability
  </Accordion>

  <Accordion title="A/B Testing" icon="flask">
    **Traffic Splitting**: Route percentage of traffic to different versions

    **Performance Comparison**: Compare success rates and confidence scores

    **Automated Optimization**: Auto-promote better performing versions

    **Statistical Significance**: Built-in statistical analysis of results
  </Accordion>

  <Accordion title="Deployment Pipeline" icon="rocket">
    **Environment Promotion**: Move templates through dev → staging → production

    **Approval Workflows**: Require approval for production deployments

    **Automated Testing**: Run test suites before deployment

    **Rollout Strategies**: Gradual rollout with monitoring checkpoints
  </Accordion>
</AccordionGroup>

### Field-Level Configuration

#### Advanced Field Types

<Tabs>
  <Tab title="Basic Fields">
    **String**: Labels with validation patterns
    **Number**: Measurements, coordinates, confidence scores
    **Date**: Timestamps, monitoring dates
    **Boolean**: Pass/fail, present/absent representations
  </Tab>

  <Tab title="Complex Fields">
    **Object**: Nested structures with subfields
    **Enum**: Predefined value sets with validation
    **Image**: AI-generated images based on context
  </Tab>

  <Tab title="Advanced Options">
    **Conditional Logic**: Extract fields based on conditions
    **Multi-language**: 40+ language support with translation
    **Confidence Thresholds**: Minimum confidence requirements
    **Batch Processing**: Handle multiple images efficiently
  </Tab>
</Tabs>

## API Key Management

### Multi-Environment Setup

<Tabs>
  <Tab title="Development Keys">
    **Purpose**: Testing and development work
    **Features**:

    * Unlimited regeneration
    * Detailed logging
    * Sandbox mode
    * No rate limiting
  </Tab>

  <Tab title="Production Keys">
    **Purpose**: Live application integration
    **Features**:

    * Enhanced security
    * Rate limiting
    * Usage analytics
    * Audit trails
  </Tab>

  <Tab title="Staging Keys">
    **Purpose**: Pre-production testing
    **Features**:

    * Production-like environment
    * Performance testing
    * Load testing capabilities
    * Deployment validation
  </Tab>
</Tabs>

### Key Security Features

<CardGroup cols={2}>
  <Card title="Access Control" icon="shield">
    **IP Whitelisting**: Restrict access by IP address
    **Domain Restrictions**: Limit usage to specific domains
    **Expiration Dates**: Set automatic key expiration
  </Card>

  <Card title="Monitoring" icon="eye">
    **Real-time Usage**: Live API call monitoring
    **Anomaly Detection**: Unusual usage pattern alerts
    **Geographic Tracking**: Usage by location
  </Card>
</CardGroup>

### Creating & Managing Keys

<Steps>
  <Step title="Generate New Key">
    Click "Create New Key" and specify:

    * Environment (dev/staging/production)
    * Permissions and restrictions
    * Expiration settings
    * Usage limits
  </Step>

  <Step title="Configure Security">
    Set up security parameters:

    * IP address restrictions
    * Domain whitelisting
    * Rate limiting rules
    * Access permissions
  </Step>

  <Step title="Copy & Secure">
    **Critical**: Copy the key immediately (shown only once)

    * Store in secure password manager
    * Update application configuration
    * Test API connectivity
  </Step>

  <Step title="Monitor Usage">
    Track key performance:

    * Request volume and patterns
    * Error rates and types
    * Geographic usage
    * Security alerts
  </Step>
</Steps>

## Usage Analytics & Billing

### Credit Management System

<AccordionGroup>
  <Accordion title="Credit Mechanics" icon="circle-info">
    **Simple Pricing**: 1 credit = 1 successful extraction
    **No Waste**: Failed requests don't consume credits
    **Never Expire**: Credits remain in your account indefinitely
    **Real-time Tracking**: Instant usage updates

    **Credit Consumption**:

    * Single extraction: 1 credit
    * Batch processing: 1 credit per image
    * Failed requests: 0 credits
    * Retries: Only successful extractions count
  </Accordion>

  <Accordion title="Usage Analytics" icon="chart-bar">
    **Comprehensive Metrics**:

    * Daily/weekly/monthly usage trends
    * Template-specific consumption
    * Success rate analytics
    * Performance benchmarking

    **Predictive Analytics**:

    * Projected depletion dates
    * Usage pattern analysis
    * Cost optimization recommendations
    * Seasonal trend identification
  </Accordion>

  <Accordion title="Credit Packages" icon="credit-card">
    **Flexible Pricing**:

    * **Starter**: 100 credits for \$9.99 (ideal for testing)
    * **Growth**: 500 credits for \$39.99 (small businesses)
    * **Scale**: 1,500 credits for \$99.99 (enterprise usage)

    **Enterprise Options**:

    * Custom packages for high-volume users
    * Volume discounts for 10,000+ credits
    * Annual billing with additional savings
  </Accordion>
</AccordionGroup>

### Performance Dashboard

#### Template Performance Metrics

<CardGroup cols={2}>
  <Card title="Success Rates" icon="chart-bar">
    **Template-Level**: Overall success percentage
    **Field-Level**: Individual field extraction rates
    **Trend Analysis**: Performance over time
    **Benchmark Comparison**: vs. similar templates
  </Card>

  <Card title="Confidence Scores" icon="gauge">
    **Average Scores**: Mean confidence across extractions
    **Score Distribution**: Histogram of confidence ranges
    **Field Analysis**: Per-field confidence metrics
    **Quality Thresholds**: Customizable quality gates
  </Card>

  <Card title="Processing Time" icon="clock">
    **Average Latency**: Mean response time
    **Performance Trends**: Speed over time analysis
    **Bottleneck Identification**: Slow field detection
    **Optimization Suggestions**: Performance improvements
  </Card>

  <Card title="Error Analysis" icon="x">
    **Error Types**: Categorized failure reasons
    **Common Patterns**: Recurring extraction issues
    **Image Quality Issues**: Resolution/clarity problems
    **Improvement Recommendations**: Actionable fixes
  </Card>
</CardGroup>

## Settings & Configuration

### Account Management

<Tabs>
  <Tab title="Profile Settings">
    **Basic Information**:

    * Display name and contact email
    * Password management with 2FA
    * Time zone configuration
    * Notification preferences

    **Professional Settings**:

    * Company information
    * Team member management
    * Billing contact details
  </Tab>

  <Tab title="Dashboard Preferences">
    **UI Customization**:

    * Light/dark theme selection
    * Dashboard layout preferences
    * Metric display options
    * Default view settings

    **Data Preferences**:

    * Default template categories
    * Performance metric priorities
    * Alert thresholds
    * Export formats
  </Tab>

  <Tab title="Security Settings">
    **Authentication**:

    * Two-factor authentication setup
    * Login history and active sessions
    * Password policies
    * Account recovery options

    **API Security**:

    * Global rate limiting
    * IP whitelisting preferences
    * Audit log retention
    * Security alert settings
  </Tab>
</Tabs>

### Advanced Integrations

#### Webhook Configuration

<Steps>
  <Step title="Webhook Setup">
    Configure real-time notifications:

    * Extraction completion events
    * Template performance alerts
    * Credit usage notifications
    * Error condition alerts
  </Step>

  <Step title="Event Selection">
    Choose which events to receive:

    * Successful extractions
    * Failed processing attempts
    * Template version updates
    * Usage threshold alerts
  </Step>

  <Step title="Endpoint Configuration">
    Set up your webhook endpoint:

    * URL validation and testing
    * Authentication headers
    * Retry policies
    * Timeout settings
  </Step>

  <Step title="Testing & Validation">
    Verify webhook functionality:

    * Test event delivery
    * Payload format validation
    * Error handling verification
    * Performance monitoring
  </Step>
</Steps>

#### API Integration Tools

<CardGroup cols={2}>
  <Card title="SDKs & Libraries" icon="code">
    **Official SDKs**: Python, JavaScript, Go, PHP
    **Community Libraries**: Additional language support
    **Code Examples**: Ready-to-use integration snippets
    **Documentation**: Comprehensive API reference
  </Card>

  <Card title="Testing Tools" icon="flask">
    **API Playground**: Interactive API testing
    **Postman Collections**: Pre-configured API collections
    **Mock Services**: Testing without credit consumption
    **Performance Testing**: Load testing capabilities
  </Card>
</CardGroup>

## Mobile Dashboard Experience

### Responsive Design Features

<CardGroup cols={2}>
  <Card title="Mobile Optimized" icon="mobile">
    **Adaptive Layout**: Optimized for all screen sizes
    **Touch Interface**: Finger-friendly navigation
    **Offline Capability**: Core features work offline
    **Progressive Web App**: Install as mobile app
  </Card>

  <Card title="Quick Actions" icon="bolt">
    **Swipe Gestures**: Quick template actions
    **Voice Commands**: Hands-free operation
    **Camera Integration**: Direct image upload
    **Location Services**: Geo-tagged extractions
  </Card>
</CardGroup>

### Mobile-Specific Features

* **Camera Upload**: Direct photo capture for extraction
* **Offline Mode**: Queue extractions when offline
* **Push Notifications**: Real-time alerts and updates
* **Voice Notes**: Audio field descriptions
* **GPS Tagging**: Location-based template suggestions

## Getting Help & Support

### Self-Service Resources

<CardGroup cols={3}>
  <Card title="Interactive Help" icon="circle-question">
    **Contextual Tooltips**: Hover help throughout dashboard
    **Interactive Tours**: Guided walkthroughs for new features
    **Video Tutorials**: Step-by-step visual guidance
  </Card>

  <Card title="Knowledge Base" icon="book">
    **Searchable Articles**: Complete documentation
    **FAQ Section**: Common questions and answers
    **Best Practices**: Template optimization guides
  </Card>

  <Card title="Community Forum" icon="users">
    **User Community**: Connect with other developers
    **Template Sharing**: Share and discover templates
    **Success Stories**: Real-world implementation examples
  </Card>
</CardGroup>

### Direct Support Options

<CardGroup cols={2}>
  <Card title="Live Chat Support" icon="message">
    **Business Hours**: Real-time assistance during 9 AM - 6 PM EST
    **Technical Support**: API integration help
    **Template Optimization**: Performance improvement guidance
  </Card>

  <Card title="Email Support" icon="envelope" href="mailto:support@vizapi.ai">
    **Complex Issues**: Detailed technical problems
    **Account Issues**: Billing and account management
    **Feature Requests**: New functionality suggestions
  </Card>
</CardGroup>

***

<Note>
  **Pro Tip**: The dashboard is continuously updated with new features based on user feedback. Enable notifications in your settings to stay informed about new capabilities and improvements!
</Note>