BizKitHub
DocsAPI ReferenceDashboard/bff/dashboard/email-stats
getDashboardAdmin BFF

/bff/dashboard/email-stats

Shows health of transactional emails (invoices, notifications, password resets). Not marketing - critical system health indicator.

DashboardgetBffDashboardEmail-stats

Parameters

1 query

Query parameters

· 1
daysnumberOptional

Number of days to analyze. Defaults to 30.

Default: 30
Example30

Response schema

1 status code documented

200SuccessEmail statistics analysis.
summaryobjectRequired
totalEmailsnumberRequired

Total emails.

sentEmailsnumberRequired

Successfully sent.

failedEmailsnumberRequired

Failed to send.

pendingEmailsnumberRequired

Pending/queued.

openedEmailsnumberRequired

Opened emails.

deliveryRatenumberRequired

Delivery rate (0-100%).

openRatenumberRequired

Open rate (0-100%).

byTagobject[]Required

Stats by email type.

Each array item:
tagstringRequired

Email tag/type.

tagLabelstringRequired

Tag label.

totalnumberRequired

Total emails.

sentnumberRequired

Sent emails.

failednumberRequired

Failed emails.

openednumberRequired

Opened emails.

deliveryRatenumberRequired

Delivery rate (0-100%).

openRatenumberRequired

Open rate (0-100%).

dailyTrendobject[]Required

Daily email trend.

Each array item:
datestringRequired

Date (YYYY-MM-DD).

sentnumberRequired

Sent count.

failednumberRequired

Failed count.

openednumberRequired

Opened count.

recentFailuresobject[]Required

Recent failed emails (max 20).

Each array item:
emailIdnumberRequired

Email ID.

externalIdstringRequired

External email ID.

subjectstringRequired

Email subject.

insertedDatestringRequired

Creation date (ISO).

failedAttemptsnumberRequired

Failed attempt count.

Response example

application/json
{
  "summary": {
    "totalEmails": 0,
    "sentEmails": 0,
    "failedEmails": 0,
    "pendingEmails": 0,
    "openedEmails": 0,
    "deliveryRate": 0,
    "openRate": 0
  },
  "byTag": [
    {
      "tag": "example_tag",
      "tagLabel": "example_tagLabel",
      "total": 0,
      "sent": 0,
      "failed": 0,
      "opened": 0,
      "deliveryRate": 0,
      "openRate": 0
    }
  ],
  "dailyTrend": [
    {
      "date": "example_date",
      "sent": 0,
      "failed": 0,
      "opened": 0
    }
  ],
  "recentFailures": [
    {
      "emailId": 0,
      "externalId": "example_externalId",
      "subject": "example_subject",
      "insertedDate": "example_insertedDate",
      "failedAttempts": 0
    }
  ]
}

Request example

GET /bff/dashboard/email-stats

get
curl -X GET "https://api.bizkithub.com/bff/dashboard/email-stats?days=30" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key