Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.oppla.ai/llms.txt

Use this file to discover all available pages before exploring further.

Compare Tours

Learn how to compare tour performance and analyze metrics in Oppla.

Basic Usage

Compare Tour Metrics

import { createTour, TourManager } from '@oppla-ai/tours';

// Create tour manager
const manager = new TourManager();

// Compare tour metrics
const comparison = manager.compare({
  tours: ['feature-tour', 'onboarding-tour'],
  metrics: ['completion_rate', 'average_time'],
  timeRange: 'last_30_days'
});

Compare Tour Steps

// Compare specific steps
const stepComparison = manager.compare({
  tours: ['feature-tour', 'onboarding-tour'],
  steps: [0, 1],
  metrics: ['view_count', 'interaction_rate']
});

Advanced Features

Compare with Filters

// Compare with filters
const filteredComparison = manager.compare({
  tours: ['feature-tour', 'onboarding-tour'],
  metrics: ['completion_rate'],
  filters: {
    userSegment: 'premium',
    deviceType: 'desktop',
    timeRange: 'last_7_days'
  }
});

Compare with Custom Metrics

// Compare with custom metrics
const customComparison = manager.compare({
  tours: ['feature-tour', 'onboarding-tour'],
  metrics: [
    'completion_rate',
    'average_time',
    {
      name: 'custom_metric',
      calculation: (data) => {
        return data.interactions / data.views;
      }
    }
  ]
});

Best Practices

  1. Be Specific: Compare relevant metrics
  2. Be Consistent: Use consistent time ranges
  3. Be Clear: Document comparison logic
  4. Be Accurate: Validate comparison data

Common Issues

Comparison Not Working

  • Check tour IDs
  • Verify metrics
  • Check time ranges
  • Ensure proper data

Data Quality

  • Validate metrics
  • Check for outliers
  • Verify calculations
  • Review time periods

Next Steps

Tooltips

Learn about tooltip steps

Modals

Learn about modal steps