Platform Essentials
Dashboard Guide
Master your VizAPI.ai dashboard - your control center for visual data extraction and template management
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.Template Management
Create, edit, and version extraction templates
API Keys & Security
Control access, environments, and security settings
Usage Analytics
Monitor credits, performance, and template success rates
Account Settings
Preferences, billing, and advanced configurations
Home Dashboard
Quick Actions Hub
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.
Performance Metrics
Total Templates
Total Templates
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
API Calls This Month
API Calls This Month
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
Active Templates
Active Templates
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
Top Performing Template
Top Performing Template
Your highest-traffic template with detailed analytics.Click to View:
- Confidence score trends
- Field-level performance
- Usage patterns
- Version history
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
Performance Filters
- High Performers:
>95%success rate - Needs Attention:
<85%success rate - Recently Used: Active in last 7 days
- Draft Status: Unpublished templates
Content Filters
- 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
Template Actions Menu
Edit Template
Visual Editor: Modify fields, descriptions, and settings
Version Control: Save as new version or update current
Live Testing: Test changes with real images
Clone Template
Smart Duplication: Create variations for A/B testing
Bulk Operations: Clone multiple templates at once
Cross-Category: Adapt templates for different use cases
Performance Analytics
Detailed Metrics: Field-level success rates and confidence scores
Usage Trends: Daily/weekly/monthly usage patterns
Error Analysis: Common failure points and solutions
API Integration
Code Snippets: Copy-paste integration examples
Webhook Setup: Real-time extraction notifications
Batch Processing: Multi-image extraction examples
Template Library
Enhanced Browsing Experience
Smart Categories
Agriculture & Farming
Templates: Plant disease detection, crop monitoring, livestock analysis
Use Cases: Precision farming, yield optimization, health monitoring
Key Features: Multi-species support, severity classification
Medical & Diagnostics
Templates: X-ray analysis, skin lesion detection, diagnostic imaging
Use Cases: Healthcare diagnostics, medical screening, triage
Key Features: HIPAA compliance, confidence scoring
Quality Control
Templates: Defect detection, surface inspection, compliance monitoring
Use Cases: Manufacturing QC, product inspection, safety compliance
Key Features: Pass/fail detection, defect classification
Security & Surveillance
Templates: Object detection, crowd analysis, threat assessment
Use Cases: Security monitoring, access control, safety management
Key Features: Real-time analysis, alert systems
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
1
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
2
Test & Validate
Upload your own images to test template performance:
- Real-time extraction results
- Confidence score analysis
- Field-by-field validation
3
Deploy & Customize
Click “Use Template” to deploy:
- Optional field customization
- Version selection (latest or specific)
- Environment targeting (dev/staging/prod)
4
Monitor & Optimize
Track performance and make improvements:
- Success rate monitoring
- Confidence score trends
- Version comparison analytics
Advanced Template Features
Template Versioning Control
Version Management
Version Management
Create Versions: Save template changes as new versions (1.0, 1.1, 2.0)Version Comparison: Side-by-side comparison of different versionsRollback Capability: Instantly revert to previous versionsAPI Version Control: Specify exact versions in API calls for production stability
A/B Testing
A/B Testing
Traffic Splitting: Route percentage of traffic to different versionsPerformance Comparison: Compare success rates and confidence scoresAutomated Optimization: Auto-promote better performing versionsStatistical Significance: Built-in statistical analysis of results
Deployment Pipeline
Deployment Pipeline
Environment Promotion: Move templates through dev → staging → productionApproval Workflows: Require approval for production deploymentsAutomated Testing: Run test suites before deploymentRollout Strategies: Gradual rollout with monitoring checkpoints
Field-Level Configuration
Advanced Field Types
String: Labels with validation patterns
Number: Measurements, coordinates, confidence scores
Date: Timestamps, monitoring dates
Boolean: Pass/fail, present/absent representations
API Key Management
Multi-Environment Setup
Purpose: Testing and development work
Features:
- Unlimited regeneration
- Detailed logging
- Sandbox mode
- No rate limiting
Key Security Features
Access Control
IP Whitelisting: Restrict access by IP address
Domain Restrictions: Limit usage to specific domains
Expiration Dates: Set automatic key expiration
Monitoring
Real-time Usage: Live API call monitoring
Anomaly Detection: Unusual usage pattern alerts
Geographic Tracking: Usage by location
Creating & Managing Keys
1
Generate New Key
Click “Create New Key” and specify:
- Environment (dev/staging/production)
- Permissions and restrictions
- Expiration settings
- Usage limits
2
Configure Security
Set up security parameters:
- IP address restrictions
- Domain whitelisting
- Rate limiting rules
- Access permissions
3
Copy & Secure
Critical: Copy the key immediately (shown only once)
- Store in secure password manager
- Update application configuration
- Test API connectivity
4
Monitor Usage
Track key performance:
- Request volume and patterns
- Error rates and types
- Geographic usage
- Security alerts
Usage Analytics & Billing
Credit Management System
Credit Mechanics
Credit Mechanics
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 updatesCredit Consumption:
- Single extraction: 1 credit
- Batch processing: 1 credit per image
- Failed requests: 0 credits
- Retries: Only successful extractions count
Usage Analytics
Usage Analytics
Comprehensive Metrics:
- Daily/weekly/monthly usage trends
- Template-specific consumption
- Success rate analytics
- Performance benchmarking
- Projected depletion dates
- Usage pattern analysis
- Cost optimization recommendations
- Seasonal trend identification
Credit Packages
Credit Packages
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)
- Custom packages for high-volume users
- Volume discounts for 10,000+ credits
- Annual billing with additional savings
Performance Dashboard
Template Performance Metrics
Success Rates
Template-Level: Overall success percentage
Field-Level: Individual field extraction rates
Trend Analysis: Performance over time
Benchmark Comparison: vs. similar templates
Confidence Scores
Average Scores: Mean confidence across extractions
Score Distribution: Histogram of confidence ranges
Field Analysis: Per-field confidence metrics
Quality Thresholds: Customizable quality gates
Processing Time
Average Latency: Mean response time
Performance Trends: Speed over time analysis
Bottleneck Identification: Slow field detection
Optimization Suggestions: Performance improvements
Error Analysis
Error Types: Categorized failure reasons
Common Patterns: Recurring extraction issues
Image Quality Issues: Resolution/clarity problems
Improvement Recommendations: Actionable fixes
Settings & Configuration
Account Management
Basic Information:
- Display name and contact email
- Password management with 2FA
- Time zone configuration
- Notification preferences
- Company information
- Team member management
- Billing contact details
Advanced Integrations
Webhook Configuration
1
Webhook Setup
Configure real-time notifications:
- Extraction completion events
- Template performance alerts
- Credit usage notifications
- Error condition alerts
2
Event Selection
Choose which events to receive:
- Successful extractions
- Failed processing attempts
- Template version updates
- Usage threshold alerts
3
Endpoint Configuration
Set up your webhook endpoint:
- URL validation and testing
- Authentication headers
- Retry policies
- Timeout settings
4
Testing & Validation
Verify webhook functionality:
- Test event delivery
- Payload format validation
- Error handling verification
- Performance monitoring
API Integration Tools
SDKs & Libraries
Official SDKs: Python, JavaScript, Go, PHP
Community Libraries: Additional language support
Code Examples: Ready-to-use integration snippets
Documentation: Comprehensive API reference
Testing Tools
API Playground: Interactive API testing
Postman Collections: Pre-configured API collections
Mock Services: Testing without credit consumption
Performance Testing: Load testing capabilities
Mobile Dashboard Experience
Responsive Design Features
Mobile Optimized
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
Quick Actions
Swipe Gestures: Quick template actions
Voice Commands: Hands-free operation
Camera Integration: Direct image upload
Location Services: Geo-tagged extractions
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
Interactive Help
Contextual Tooltips: Hover help throughout dashboard
Interactive Tours: Guided walkthroughs for new features
Video Tutorials: Step-by-step visual guidance
Knowledge Base
Searchable Articles: Complete documentation
FAQ Section: Common questions and answers
Best Practices: Template optimization guides
Community Forum
User Community: Connect with other developers
Template Sharing: Share and discover templates
Success Stories: Real-world implementation examples
Direct Support Options
Live Chat Support
Business Hours: Real-time assistance during 9 AM - 6 PM EST
Technical Support: API integration help
Template Optimization: Performance improvement guidance
Email Support
Complex Issues: Detailed technical problems
Account Issues: Billing and account management
Feature Requests: New functionality suggestions
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!