Documentation Index
Fetch the complete documentation index at: https://docs.fanfare.io/llms.txt
Use this file to discover all available pages before exploring further.
Reports
Reports allow you to generate detailed analytics exports for specific metrics, time periods, and segments. Use reports for deeper analysis, stakeholder presentations, and compliance requirements.
Report Types
Standard Reports
| Report | Description |
|---|
| Experience Summary | Overview of all experience performance |
| Consumer Activity | Consumer engagement and participation |
| Revenue Report | Financial performance analysis |
| Conversion Report | Funnel and conversion analytics |
| Usage Report | Platform usage and consumption |
Experience Reports
| Report | Description |
|---|
| Queue Performance | Wait times, completion, throughput |
| Draw Results | Entry counts, winner distribution |
| Auction Analysis | Bidding patterns, final prices |
| Appointment Summary | Booking rates, attendance metrics |
Generating Reports
Standard Report Generation
- Navigate to the reports section
- Select a report type
- Configure parameters
- Generate the report
- Download or view online
Caption: Configure and generate custom reports
Report Parameters
| Parameter | Description |
|---|
| Date Range | Start and end dates |
| Experiences | All or selected experiences |
| Audiences | All or specific audiences |
| Metrics | Which metrics to include |
| Grouping | How to group data |
Date Range Selection
Preset Ranges
| Preset | Description |
|---|
| Today | Current day |
| Yesterday | Previous day |
| Last 7 days | Rolling week |
| Last 30 days | Rolling month |
| This month | Calendar month to date |
| Last month | Previous calendar month |
| This quarter | Quarter to date |
| Last quarter | Previous quarter |
| Custom | Specify exact dates |
Custom Date Range
- Click Custom
- Select start date
- Select end date
- Apply the range
Caption: Select custom date ranges for reports
Report Metrics
Experience Metrics
| Metric | Description |
|---|
| Total Entries | Number of experience entries |
| Unique Entrants | Distinct consumers |
| Completion Rate | Percentage completed |
| Average Wait Time | Mean time in experience |
| Drop-off Rate | Percentage who left early |
Consumer Metrics
| Metric | Description |
|---|
| New Consumers | First-time participants |
| Returning Consumers | Repeat participants |
| Consumer Growth | Net new consumers |
| Engagement Rate | Activity per consumer |
Revenue Metrics
| Metric | Description |
|---|
| Total Revenue | Sum of transactions |
| Average Order Value | Mean transaction amount |
| Revenue Per Entry | Revenue divided by entries |
| Transaction Count | Number of transactions |
| Format | Best For |
|---|
| CSV | Data analysis, spreadsheets |
| Excel (.xlsx) | Formatted reports, formulas |
| PDF | Presentations, sharing |
| JSON | API integration, automation |
CSV Options
- Include headers
- Date format
- Number format
- Delimiter choice
Excel Options
- Multiple sheets
- Charts included
- Formatting applied
- Summary sheet
PDF Options
- Include charts
- Page orientation
- Paper size
- Branding
Scheduled Reports
Setting Up Scheduled Reports
- Create a report configuration
- Click Schedule
- Set frequency
- Choose delivery method
- Save the schedule
Caption: Set up automatic report delivery
Frequency Options
| Frequency | Description |
|---|
| Daily | Every day at specified time |
| Weekly | Specific day each week |
| Monthly | Specific day each month |
| Quarterly | End of each quarter |
Delivery Methods
| Method | Description |
|---|
| Email | Send to specified addresses |
| Download | Available in reports section |
| Webhook | POST to specified URL |
Report History
Viewing Past Reports
Access previously generated reports:
| Information | Description |
|---|
| Report Name | Type and parameters |
| Generated At | When the report was created |
| Generated By | Who requested the report |
| Status | Complete, pending, or failed |
| Download | Link to download |
Report Retention
| Plan | Report History |
|---|
| Free | 7 days |
| Basic | 30 days |
| Pro | 90 days |
| Enterprise | 1 year |
Advanced Reporting
Filtering Data
Apply filters to narrow report scope:
| Filter | Options |
|---|
| Experience Type | Queue, Draw, Auction, Appointment |
| Audience | Specific audience segments |
| Status | Completed, pending, cancelled |
| Consumer Status | New, returning |
Grouping Data
Group report data by:
| Grouping | Description |
|---|
| Day | Daily aggregation |
| Week | Weekly aggregation |
| Month | Monthly aggregation |
| Experience | Per-experience breakdown |
| Audience | Per-audience breakdown |
Comparing Periods
Compare metrics across time periods:
- Select primary period
- Enable comparison
- Select comparison period
- View side-by-side metrics
Report Templates
Saving Templates
Save report configurations for reuse:
- Configure report parameters
- Click Save as Template
- Name the template
- Access from template library
Using Templates
- Open template library
- Select a template
- Adjust parameters if needed
- Generate the report
API Access
Report API
Programmatically generate reports:
curl -X POST "https://api.fanfare.io/v1/reports" \
-H "Authorization: Bearer sk_live_xxxxx" \
-H "Content-Type: application/json" \
-d '{
"type": "experience_summary",
"startDate": "2024-01-01",
"endDate": "2024-01-31",
"format": "json"
}'
Webhook Delivery
Receive reports via webhook:
- Configure webhook URL
- Set report parameters
- Schedule or generate
- Report POSTed to URL
Best Practices
Report Design
- Start with questions - Know what you want to learn
- Choose appropriate metrics - Select relevant data
- Use meaningful ranges - Compare like periods
- Include context - Add notes and explanations
Report Distribution
- Schedule regular reports - Automate routine reports
- Use appropriate formats - Match format to audience
- Secure sensitive data - Limit access as needed
- Archive important reports - Download for records
Troubleshooting
Report Generation Failed
- Check date range is valid
- Verify you have data for the period
- Ensure you have permission
- Try a smaller date range
Data Looks Incorrect
- Verify date range selection
- Check timezone settings
- Confirm metric definitions
- Compare with dashboard data
Scheduled Report Not Delivered
- Check email spam folder
- Verify email addresses
- Confirm schedule is active
- Check report generation status