Skip to main content

Campaign Analytics

Retrieve detailed analytics and performance metrics for a specific email campaign.

📝 Endpoint

📋 Query Parameters

string
required
The unique identifier of the campaign to analyze.

📤 Request Example

📥 Response

Success (200 OK)

Error Responses

Campaign Not Found (400 Bad Request)

Missing Campaign ID (400 Bad Request)

Insufficient Permissions (403 Forbidden)

📊 Analytics Metrics Explained

Basic Metrics

  • openCount: Total number of email opens
  • openRate: Percentage of emails opened (opens / sent)
  • uniqueOpens: Number of unique recipients who opened
  • repeatOpens: Number of times the same recipient opened
  • clickCount: Total number of link clicks
  • clickRate: Percentage of emails with clicks (clicks / sent)
  • uniqueClicks: Number of unique recipients who clicked
  • repeatClicks: Number of times the same recipient clicked

Engagement Metrics

  • engagementScore: Overall engagement score (0-1)
  • bounceCount: Number of bounced emails
  • complaintCount: Number of spam complaints
  • firstOpenTime: Time to first open (in nanoseconds)
  • averageReadTime: Average time between open and click

Comparative Metrics

  • industryAvgOpenRate: Industry average open rate
  • industryAvgClickRate: Industry average click rate

Geographic Analytics

  • geoBreakdown: Opens by country
  • cityBreakdown: Opens by city
  • regionBreakdown: Opens by region

Device & Browser Analytics

  • deviceBreakdown: Opens by device type
  • browserBreakdown: Opens by browser
  • osBreakdown: Opens by operating system

Time-based Analytics

  • hourlyBreakdown: Opens by hour (0-23)
  • dayOfWeekBreakdown: Opens by day of week
  • timelineData: Detailed timeline of events
  • clickedLinks: Detailed analytics for each clicked link
    • url: The clicked URL
    • clickCount: Total clicks on this link
    • uniqueClicks: Unique recipients who clicked
    • clickRate: Click rate for this link
    • averageTimeToClick: Average time to click
    • firstClickTime: First click timestamp
    • lastClickTime: Last click timestamp
    • deviceBreakdown: Clicks by device type

📈 Using Analytics Data

Calculate Performance Metrics

Create Visualizations

Monitor Performance

🔄 Real-time Updates

Polling for Updates

Webhook Integration