Tracking

Retrieve open/click tracking events and aggregate email statistics.

Tracking is automatically enabled for emails sent with HTML content. Open tracking uses a transparent pixel, click tracking rewrites links. Use the stats endpoint for aggregate metrics across all sent emails.

Endpoints

Method	Path	Description	Permission
GET		Get tracking events	tracking.read
GET		Get global statistics	tracking.read

Get Tracking Events

GET /api/v1/tracking/:emailId

Request

Response

{
  "success": true,
  "data": [
    {
      "id": "evt-uuid-1",
      "type": "open",
      "timestamp": "2026-03-18T10:05:00Z",
      "ip": "203.0.113.42",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"
    },
    {
      "id": "evt-uuid-2",
      "type": "click",
      "timestamp": "2026-03-18T10:06:30Z",
      "ip": "203.0.113.42",
      "url": "https://example.com/pricing",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"
    }
  ]
}

json

Get Global Stats

GET /api/v1/stats

Request

Response

{
  "success": true,
  "data": {
    "sent": 1250,
    "delivered": 1230,
    "opens": 890,
    "uniqueOpens": 654,
    "clicks": 234,
    "uniqueClicks": 189,
    "bounces": 15,
    "complaints": 2,
    "unsubscribes": 8,
    "openRate": 53.2,
    "clickRate": 15.4,
    "bounceRate": 1.2
  }
}

json