CPaaS GuideEmail GuideWhatsApp GuideRCS GuideSMS Guide
API Guide
BlogLogin

Events API

Use Events API to track, analyse, and export your email activity.

Overview

The Events API helps you track, analyse, and export email activity generated through Email API. It gives access to delivery and engagement signals so your teams can monitor performance, troubleshoot issues, and power reporting systems.

In the email context, events are system-recorded actions that occur after an email is processed or interacted with, such as:

Sent, Delivered, Opened, Clicked, Bounced, Dropped or failed, Marked as spam, Unsubscribed

Why this event data matters

Event data helps teams:

  • Monitor campaign performance
  • Measure engagement and conversions
  • Track delivery success and failures
  • Diagnose bounce or drop patterns
  • Validate campaign reach
  • Build internal dashboards
  • Feed BI and analytics systems
  • Run deliverability audits

Endpoint

Below is a practical overview of each Events API endpoint and what you use it for.

Fetch Summary Stats — GET

Retrieve high-level aggregated metrics for email events.

Use this endpoint when you want:

  • Campaign-level performance snapshots
  • Aggregate counts (deliveries, opens, clicks, bounces)
  • Quick reporting metrics
  • Dashboard summary widgets
  • Trend monitoring

Outcome: Fast, lightweight performance overview without pulling raw logs.

Fetch Event Logs — GET

Retrieve detailed, event-level records for emails.

Use this endpoint when you need:

  • Individual event entries
  • User-level engagement tracking
  • Failure investigation
  • Click/open trail analysis
  • Time-based event filtering
  • Data for custom dashboards

Outcome: Structured event records for deep inspection and application-level analytics.

Download Logs — POST

Generate and download event log files for offline or bulk processing.

Use this endpoint when you want:

  • Bulk export of event data
  • Offline analysis
  • Data warehouse ingestion
  • BI tool imports
  • Compliance or audit archives
  • Large dataset extraction

Outcome: File-based event dataset for external systems and long-term storage.

Use Case Example

Scenario: Email Analytics & Deliverability Monitoring

An analytics and deliverability team wants to monitor campaign engagement and investigate failures. They also maintain a BI dashboard and a data warehouse.

Here’s how they use the Email Events API end-to-end:

Step 1: Get Overall Performance Snapshot

Use the Fetch Summary Stats endpoint to pull aggregated metrics to understand campaign performance:

For example; Total emails delivered, Open and click rates, Bounce counts

Step 2: Investigate Specific Behaviors

Use the Fetch Event Logs endpoint if bounce rates or engagement look unusual, the team retrieves detailed logs like:

  • Identify which recipients bounced
  • Check timestamps of opens and clicks
  • Analyze domain-level failures
  • Investigate delivery delays
  • Correlate events with campaign IDs

Step 3: Export Data

Use the Download Logs endpoint for deeper analysis, the data team exports event logs in bulk:

  • Import into data warehouse
  • Join with CRM or campaign datasets
  • Build long-term engagement models
  • Run cohort and retention analysis

This enables:

  • Advanced BI dashboards
  • Cross-channel analytics
  • Historical performance tracking
  • Predictive engagement modeling