Analytics API

Retrieve analytics and performance metrics across all channels for your organisation.

Required permission: readAnalytics

GET/api/v1/analytics

Get aggregated analytics data with daily breakdown

Query Parameters

days	Number of days to look back (default: 30, max: 90)
startDate	Start date (ISO 8601 format)
endDate	End date (ISO 8601 format)

Example Request

curl -X GET "https://yourapp.com/api/v1/analytics?days=30" \
  -H "Authorization: Bearer ntfn_your_api_key"

Response

{
  "success": true,
  "period": {
    "startDate": "2024-01-01T00:00:00.000Z",
    "endDate": "2024-01-31T23:59:59.999Z",
    "days": 31
  },
  "totals": {
    "emailsSent": 15420,
    "emailsDelivered": 15180,
    "emailsOpened": 8550,
    "uniqueOpens": 6230,
    "emailsClicked": 2150,
    "uniqueClicks": 1890,
    "emailsBounced": 120,
    "emailsComplained": 5,
    "unsubscribes": 45,
    "newContacts": 320,
    "campaignsSent": 12
  },
  "rates": {
    "deliveryRate": "98.44",
    "openRate": "41.04",
    "clickRate": "30.34",
    "bounceRate": "0.78",
    "unsubscribeRate": "0.30"
  },
  "daily": [
    {
      "date": "2024-01-01T00:00:00.000Z",
      "emailsSent": 520,
      "emailsDelivered": 515,
      "emailsOpened": 280,
      "emailsClicked": 75,
      "emailsBounced": 3,
      "openRate": 54.37,
      "clickRate": 26.79
    },
    // ... more daily entries
  ]
}

Understanding Metrics

Delivery Rate

Percentage of emails successfully delivered to recipients' inboxes.

(emailsDelivered / emailsSent) × 100

Open Rate

Percentage of delivered emails that were opened (unique opens).

(uniqueOpens / emailsDelivered) × 100

Click Rate

Percentage of opened emails that had at least one click.

(uniqueClicks / uniqueOpens) × 100

Bounce Rate

Percentage of emails that bounced (hard + soft bounces).

(emailsBounced / emailsSent) × 100

Best Practices

1Cache analytics responses for at least 5 minutes to reduce API calls
2Use date range parameters for historical analysis instead of high day counts
3Monitor bounce rates closely - high rates can affect deliverability
4Track trends over time rather than focusing on individual day metrics

{ "success": true, "period": { "startDate": "2024-01-01T00:00:00.000Z", "endDate": "2024-01-31T23:59:59.999Z", "days": 31 }, "totals": { "emailsSent": 15420, "emailsDelivered": 15180, "emailsOpened": 8550, "uniqueOpens": 6230, "emailsClicked": 2150, "uniqueClicks": 1890, "emailsBounced": 120, "emailsComplained": 5, "unsubscribes": 45, "newContacts": 320, "campaignsSent": 12 }, "rates": { "deliveryRate": "98.44", "openRate": "41.04", "clickRate": "30.34", "bounceRate": "0.78", "unsubscribeRate": "0.30" }, "daily": [ { "date": "2024-01-01T00:00:00.000Z", "emailsSent": 520, "emailsDelivered": 515, "emailsOpened": 280, "emailsClicked": 75, "emailsBounced": 3, "openRate": 54.37, "clickRate": 26.79 }, // ... more daily entries ] }