🔌 API Reference

Analytics

Event analytics and reporting

Analytics API

Access event analytics, metrics, and reporting data.

Event Overview

Get comprehensive analytics for an event:

GET /api/v1/analytics/events/{event_id}/overview

Response:
{
  "total_guests": 500,
  "checked_in": 423,
  "rsvp_accepted": 450,
  "rsvp_declined": 30,
  "rsvp_pending": 20,
  "check_in_rate": 84.6,
  "response_rate": 96.0,
  "average_companions": 1.5
}

Check-In Timeline

Get time-series data for check-ins:

GET /api/v1/analytics/events/{event_id}/timeline

Organization Summary

Get organization-wide analytics across all events:

GET /api/v1/analytics/organization/summary

Metrics Included

  • Total guests and attendance rates
  • RSVP response breakdown
  • Check-in patterns and timelines
  • Guest type distribution
  • Companion statistics
  • Response rate percentages

© 2025 FreePas. All rights reserved.