Retrieve stats

Email counts by status for every project, for today, the last 7 days and the last 30 days.

GET/v1/admin/statsAdmin key

A quick health view across projects. Emails are counted by their current status and by when they were created. For charts over time, rates and delivery times, use analytics instead (GET /v1/admin/analytics, same shape as Retrieve analytics).

Every project is listed, including disabled ones, oldest project first.

Response

dataStats[]

One entry per project.

Show stats properties

projectIdstring

The project ID.

slugstring

The project slug.

namestring

The project name.

todayRecord<string, number>

Emails created since 00:00 UTC today, by status. Statuses with no emails are left out, so a quiet project has {}.

last7dRecord<string, number>

Emails created in the last 7 × 24 hours, by status.

last30dRecord<string, number>

Emails created in the last 30 × 24 hours, by status.

Request

const res = await fetch('https://mailer.example.com/v1/admin/stats', {
  headers: { Authorization: `Bearer ${process.env.FLARESEND_ADMIN_KEY}` },
});
const { data } = await res.json();

Response

{
  "data": [
    {
      "projectId": "proj_01K6B1QZ3M8H2V5T7R9N4XW6CD",
      "slug": "acme",
      "name": "Acme",
      "today": { "delivered": 41, "queued": 2 },
      "last7d": { "delivered": 318, "bounced": 3, "queued": 2 },
      "last30d": { "delivered": 1204, "bounced": 11, "complained": 1, "queued": 2 }
    }
  ]
}

ResponseCopy Anchor Link

Response