/bff/emailer/analytics

Returns a single aggregated bundle covering six analytics sections: KPI summary (with previous-period comparisons), daily volume by template category + weekly send-time heatmap, deliverability trends (bounces, complaints, top failing recipients, top rejecting MTAs, top SMTP codes), engagement (open-rate per template type, time-to-open distribution, geo of opens), per-template funnel with A/B variants, and inbound mail analytics (received volume, spam vs actionable classification, ticket promotion rate, top senders). All queries are organisation-scoped.

EmailergetBffEmailerAnalytics

Parameters

3 query

Query parameters

· 3

dateFromstringOptional

Start of the analytics window (inclusive), ISO-8601 date or datetime. Defaults to 30 days ago.

Example2026-08-01

dateTostringOptional

End of the analytics window (exclusive), ISO-8601 date or datetime. Defaults to tomorrow (midnight UTC).

Example2026-09-01

categorystringOptional

Exampletransactional

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json

{
  "success": true
}

Request example

GET /bff/emailer/analytics

get

curl -X GET "https://api.bizkithub.com/bff/emailer/analytics?dateFrom=2026-08-01&dateTo=2026-09-01&category=transactional" \
  -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