Transactional Emails

Get stats for a single transactional email

Aggregate counts only, never a per-recipient list - response size and query cost are bounded regardless of how much activity actually happened, since every count is a single indexed query scoped to this one resource. For the actual list of recipients (who received/opened/clicked/bounced/unsubscribed), see GET /v1/projectId/{projectId}/transactional-emails/{id}/recipients. Pass interval + metric for an hourly/daily/weekly/monthly breakdown instead of totals.

get/v1/projectId/{projectId}/transactional-emails/{id}/stats

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/transactional-emails/{id}/stats
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

idstring required

The transactional email _id.

Query parameters

fromstring date-time

Only count events at or after this date/time.

tostring date-time

Only count events at or before this date/time. If both from and to are given, the range between them cannot exceed 366 days.

interval'hourly' | 'daily' | 'weekly' | 'monthly'

Returns an EmailStatsTimeline (per-period breakdown, same as the app's stats chart) instead of totals. Requires metric. With interval, from/to are rounded to whole UTC days and default to the last 7 days (hourly) or the last month (others). Max range: hourly 7 days, daily 60 days, weekly/monthly 12 months (405 when exceeded).

metric'sent' | 'failed' | 'opens' | 'uniqueOpens' | 'clicks' | 'uniqueClicks' | 'clicksPerUniqueOpens' | 'uniqueClicksPerUniqueOpens' | 'bounces' | 'complaints' | 'subscribe' | 'unsubscribe' | 'resubscribe' | 'pause-subscription' | 'unpause-subscription'

With interval: what to count per period. subscribe/unsubscribe/resubscribe/pause-subscription/unpause-subscription count subscription changes caused by this email.

timeZonestring
Example:Europe/Budapest

With interval: IANA time zone the periods are labelled in. Defaults to UTC.

Response

OK

statusinteger

Example response

{
  "status": 200,
  "result": {
    "buckets": [
      {
        "period": "2026-10-01 10:00"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.