Docs API Reference Dashboard/bff/dashboard/email-stats

/bff/dashboard/email-stats

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

DashboardgetBffDashboardEmail-stats

Parameters

1 query

1 total

Query · 1

daysnumber

Number of days to analyze. Defaults to 30.

Default: 30

Request

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"

Response

Email statistics analysis.

{
  "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
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key